From ba6579d0cf99cfbd2d8bedd5b47a8f0ff6352ba8 Mon Sep 17 00:00:00 2001 From: grassblock Date: Sun, 8 Jun 2025 22:49:12 +0800 Subject: [PATCH] chore(docs): add reference from Astro docs --- src/content/posts/markdown-example/index.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/content/posts/markdown-example/index.mdx b/src/content/posts/markdown-example/index.mdx index a0d9286..f75364b 100644 --- a/src/content/posts/markdown-example/index.mdx +++ b/src/content/posts/markdown-example/index.mdx @@ -9,6 +9,12 @@ 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. +## Markdown in Astro +> [Markdown](https://daringfireball.net/projects/markdown/) is commonly used to author text-heavy content like blog posts and documentation. Astro includes built-in support for Markdown files that can also include [frontmatter YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f) (or [TOML](https://toml.io)) to define custom properties such as a title, description, and tags. +> +> In Astro, you can author content in [GitHub Flavored Markdown](https://github.github.com/gfm/), then render it in `.astro` components. This combines a familiar writing format designed for content with the flexibility of Astro’s component syntax and architecture. + +source: [Markdown in Astro | Docs](https://docs.astro.build/en/guides/markdown-content/) ## 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.