--- title: "Markdown Syntax Example" pubDate: '2023-07-15T12:00:00Z' description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements." tags: ["markdown", "css", "html", "sample"] --- import Callout from '/src/components/shortcodes/Callout.astro'; import LinkCard from '/src/components/shortcodes/LinkCard.astro'; import Spoiler from '/src/components/shortcodes/Spoiler.astro'; This article offers a sample of basic and extended Markdown formatting that can be used, also it shows how some basic HTML elements are decorated. ## Theme Specifics This theme came with a set of shortcodes that can be used to enhance the Markdown experience. These shortcodes are located in the `/src/components/shortcodes` directory and can be used to add custom functionality or styling to your Markdown content. To use these shortcodes, you should first rename the file to a MDX (.mdx) file. Once renamed, you can use the shortcodes in your content like this: ```mdx import ExampleShortcode from '/src/components/shortcodes/ExampleShortcode.astro'; your content here... ``` ### Spoiler Inspired by the spoiler in [Moegirl wiki](https://zh.moegirl.org.cn/Mainpage), you can use the `Spoiler` component to hide content that you want to reveal later. This is useful for spoilers in game plots , movies plots, or any other content where you want to keep certain information hidden until the user chooses to reveal it. To reveal the content, readers can hover over the text to reveal it. A hot take: the theme is done through what is called 'vibe coding'. ```mdx A hot take: the theme is done through what is called 'vibe coding'. ``` You can also display a 'tip' for the reader when hovered: A hot take: the theme is done through what is called 'vibe coding'. ```mdx A hot take: the theme is done through what is called 'vibe coding'. ``` ### Callouts You can use callouts to highlight important information or warnings in your content. Callouts are styled boxes that draw attention to specific parts of the text. This is an informational callout. It can be used to provide additional context or tips. This is a warning callout. Use it to alert users about potential issues or important notes. This is an error callout. It should be used to indicate critical issues that need immediate attention. ```mdx This is an informational callout. It can be used to provide additional context or tips. This is a warning callout. Use it to alert users about potential issues or important notes. This is an error callout. It should be used to indicate critical issues that need immediate attention. ``` ### LinkCard You can use the `LinkCard` component to create cards that link to external resources or pages. This is useful for showcasing projects, documentation, or any other relevant links. ```mdx ``` On a machine with bad network, this will significantly increase build time when no other params are passed to the component. Or to customize the card further with a title and description: ## Headings The following HTML `

`—`

` elements represent six levels of section headings. `

` is the highest section level while `

` is the lowest. # H1 ## H2 ### H3 #### H4 ##### H5 ###### H6 ## Paragraph 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. Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. ## Blockquotes 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. ### Blockquote without attribution > Tiam, ad mint andaepu dandae nostion secatur sequo quae. > Note that you can use _Markdown syntax_ within a blockquote. ### Blockquote with attribution > Don't communicate by sharing memory, share memory by communicating.
> — Rob Pike[^1] [^1]: The above quote is excerpted from Rob Pike's [talk `about` nothing](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015. ## Tables Tables aren't part of the core Markdown spec, but Astro supports supports them out-of-the-box. | Name | Age | | ----- | --- | | Bob | 27 | | Alice | 23 | ### Inline Markdown within tables | Italics | Bold | Code | | --------- | -------- | ------ | | _italics_ | bold | `code` | ## Code Blocks ### Code block with backticks ```html Example HTML5 Document
Test
``` ## List Types ### Ordered List 1. First item 2. Second item 3. Third item ### Unordered List - List item - Another item - And another item ### Nested list - Fruit - Apple - Orange - Banana - Dairy - Milk - Cheese ## Other Elements — abbr, sub, sup, kbd, mark GIF is a bitmap image format. H₂O Xⁿ + Yⁿ = Zⁿ Press `CTRL`+`ALT`+`Delete` to end the session. Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.