jk.nipponalba.scot website https://jk.nipponalba.scot
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

147 lines
3.9 KiB

5 years ago
  1. +++
  2. author = "Hugo Authors"
  3. title = "Markdown Syntax Guide"
  4. date = "2020-03-11"
  5. description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
  6. tags = [
  7. "markdown",
  8. "css",
  9. "html",
  10. "themes",
  11. ]
  12. categories = [
  13. "themes",
  14. "syntax",
  15. ]
  16. series = ["Themes Guide"]
  17. aliases = ["migrate-from-jekyl"]
  18. +++
  19. This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
  20. <!--more-->
  21. ## Headings
  22. The following HTML `<h1>`—`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest.
  23. # H1
  24. ## H2
  25. ### H3
  26. #### H4
  27. ##### H5
  28. ###### H6
  29. ## Paragraph
  30. Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
  31. Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
  32. ## Blockquotes
  33. The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations.
  34. #### Blockquote without attribution
  35. > Tiam, ad mint andaepu dandae nostion secatur sequo quae.
  36. > **Note** that you can use *Markdown syntax* within a blockquote.
  37. #### Blockquote with attribution
  38. > Don't communicate by sharing memory, share memory by communicating.</p>
  39. > — <cite>Rob Pike[^1]</cite>
  40. [^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
  41. ## Tables
  42. Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box.
  43. Name | Age
  44. --------|------
  45. Bob | 27
  46. Alice | 23
  47. #### Inline Markdown within tables
  48. | Inline&nbsp;&nbsp;&nbsp; | Markdown&nbsp;&nbsp;&nbsp; | In&nbsp;&nbsp;&nbsp; | Table |
  49. | ---------- | --------- | ----------------- | ---------- |
  50. | *italics* | **bold** | ~~strikethrough~~&nbsp;&nbsp;&nbsp; | `code` |
  51. ## Code Blocks
  52. #### Code block with backticks
  53. ```
  54. html
  55. <!DOCTYPE html>
  56. <html lang="en">
  57. <head>
  58. <meta charset="UTF-8">
  59. <title>Example HTML5 Document</title>
  60. </head>
  61. <body>
  62. <p>Test</p>
  63. </body>
  64. </html>
  65. ```
  66. #### Code block indented with four spaces
  67. <!DOCTYPE html>
  68. <html lang="en">
  69. <head>
  70. <meta charset="UTF-8">
  71. <title>Example HTML5 Document</title>
  72. </head>
  73. <body>
  74. <p>Test</p>
  75. </body>
  76. </html>
  77. #### Code block with Hugo's internal highlight shortcode
  78. {{< highlight html >}}
  79. <!DOCTYPE html>
  80. <html lang="en">
  81. <head>
  82. <meta charset="UTF-8">
  83. <title>Example HTML5 Document</title>
  84. </head>
  85. <body>
  86. <p>Test</p>
  87. </body>
  88. </html>
  89. {{< /highlight >}}
  90. ## List Types
  91. #### Ordered List
  92. 1. First item
  93. 2. Second item
  94. 3. Third item
  95. #### Unordered List
  96. * List item
  97. * Another item
  98. * And another item
  99. #### Nested list
  100. * Item
  101. 1. First Sub-item
  102. 2. Second Sub-item
  103. ## Other Elements — abbr, sub, sup, kbd, mark
  104. <abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
  105. H<sub>2</sub>O
  106. X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
  107. Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session.
  108. Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.