--- title: "Markdown syntax guide" description: "Get started writing content in markdown." date: "Mar 17 2024" --- --- ### Headings To create headings, use hash symbols (#) followed by a space. The number of hash symbols indicates the heading level. ```md # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6 ```

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6
--- ### Paragraphs Simply type non-indented text, surrounded by empty lines. ```md I really like using Markdown. I think I'll use it to format all of my content from now on. ``` I really like using Markdown. I think I'll use it to format all of my content from now on. --- ### Bold Use double `*` or `_` to denote bold text. ```md it was the **best** of times, it was the __worst__ of times ``` It was the **best** of times,
it was the __worst__ of times --- ### Italic Use single `*` to denote italic text. ```md it was the age of *wisdom*, it was the age of *foolishness* ``` it was the age of *wisdom*,
it was the age of *foolishness* --- ### Bold and Italic Use `*`, `**` and `_` to combine effects. ```md it was the season of ***light***, it was the season of *__darkness__* ``` it was the season of ***light***,
it was the season of *__darkness__* --- ### Line breaks Use triple `---` to denote a line break. ```md --- ``` --- ### Links Links can be added using the `[title](url)` pattern. ```md Nano was made with [Astro](https://astro.build) ``` Nano was made with [Astro](https://astro.build) --- ### Quick link Add an quick link using the `` pattern. ```md ``` --- ### Email link Add an email link using the `` pattern. ```md Email me at using your mail app. ``` Email me at using your mail app. --- ### Ordered Lists Add a number followed by a period for items. For sub items, indent. ```md 1. Item 1 2. Item 2 1. Sub item 1 2. Sub item 2 3. Item 3 ``` 1. Item 1 2. Item 2 1. Sub item 1 2. Sub item 2 3. Item 3 --- ### Unordered List Add a `-` or `+` for items. Don't mix. For sub items, indent. ```md - Item 1 - Item 2 - Sub item 1 - Sub item 2 - Item 3 ``` - Item 1 - Item 2 - Sub item 1 - Sub item 2 - Item 3 --- ### Relative Image Use the `![title](./image.*)` pattern relative to the same folder as the markdown file. Notice the period. ```md ![Square Pants](./spongebob.webp) ``` ![Square Pants](./spongebob.webp) --- ### Public Image Use the `![title](/image.*)` pattern relative to the public folder. No period. ```md ![Patrick Starfish](/patrick.webp) ``` ![Patrick Starfish](/patrick.webp) --- ### External Image Use the `![title](url)` pattern. ```md ![Mr. Krabs](https://upload.wikimedia.org/wikipedia/en/thumb/f/f8/Mr._Krabs.svg/440px-Mr._Krabs.svg.png) ``` ![Mr. Krabs](https://upload.wikimedia.org/wikipedia/en/thumb/f/f8/Mr._Krabs.svg/440px-Mr._Krabs.svg.png) --- ### Blockquotes To add a blockquote add a `>` before a paragraph. For multi-line blockquotes, add additional `>` for each line and include an empty spacer line. ```md > it was the spring of hope, it was the winter of despair. > > Charles Dickens ``` > it was the spring of hope, it was the winter of despair. > > ~ Charles Dickens --- ### Strikethrough Use the tilde `~` symbol to strikethrough text. ```md ~The earth is round.~ The earth is flat. ``` ~The earth is round.~ The earth is flat. --- ### Subscript Use the `` tag to denote subscript. ```md H2O ``` H2O --- ### Superscript Use the `` tag to denote superscript. ```md E=mc2 ``` E=mc2 --- ### Keyboard Use the `` tag to denote keys on the keyboard. ```md CTRL + ALT + Delete ``` CTRL + ALT + Delete --- ### Abbreviate Use the `` tag to denote abbreviation. ```md GIF ``` GIF --- ### Highlight Use the `` tag to denote highlighted text. ```md Very important text ``` Very important text --- ### Task Lists Combine a list with 2 square brackets. `spc` incomplete `x` complete. ```md - [x] Take out trash - [ ] Mow the lawn - [ ] Buy more bitcoin ``` - [x] Take out trash - [ ] Mow the lawn - [ ] Buy more bitcoin --- ### Tables Use `-` for header, `|` for columns, `:` for alignment. ```md | Item | Ct | | :------ | --: | | Bread | 1 | | Milk | 1 | | Haribo | 10 | ``` | Item | Buy | | :------ | --: | | Bread | 1 | | Milk | 1 | | Haribo | 10 | --- ### Footnotes Add a caret and an id inside brackets `[^1]` to create a footnote. ```md Here's a simple footnote, [^1] and here's a another one. [^2] [^1]: This is the first footnote. [^2]: This is the second footnote. ``` Here's a simple footnote, [^1] and here's a another one. [^2] [^1]: This is the first footnote. [^2]: This is the second footnote. See the bottom of the page to view the footnotes. --- ### Code Use backticks ` to denote a word or phrase as code. ```md `package.json` ``` `package.json` --- ### Code Blocks Denote a code block by enclosing a section of valid code in triple backticks. Syntax highlight the code by using the shorthand symbol for the language. Ex: js, javascript, python ```` ```js function hello() { console.log("hello world"); } ``` ```` ```js function hello() { console.log("hello world"); } ``` --- ### Conclusion Please refer to markdownguide.org for best practices as well as advanced and extended syntax. https://www.markdownguide.org/basic-syntax https://www.markdownguide.org/extended-syntax/ ---