astro/examples/with-markdown-shiki/README.md

# Astro Example: Markdown with Shiki

```
npm init astro -- --template with-markdown-shiki
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdown-shiki)

This example showcases Astro's [built-in Markdown support](https://docs.astro.build/en/guides/markdown-content/).

- `src/pages/index.astro` uses Astro's `<Markdown>` component.
- `src/pages/other.md` is a treated as a page entrypoint and uses a `layout`.
Add Shiki as an alternative to Prism (#2497) * [ci] yarn format * Added shiki to markdown-remark * Upgraded astro shiki * Added minimal example * Changed defaults to match <Code /> * Replace `shiki` with `astro` classes * Added documentation * Updated Astro code to use new `codeToHtml` * Added changesets * Added basic test * Updated tests a bit Co-authored-by: JuanM04 <JuanM04@users.noreply.github.com> 2022-01-31 17:14:07 -05:00			`# Astro Example: Markdown with Shiki`

			```
			`npm init astro -- --template with-markdown-shiki`
			```

fix(examples): incorrect StackBlitz demo URLs (#3584) 2022-06-13 11:22:20 -05:00			`[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdown-shiki)`
Add Shiki as an alternative to Prism (#2497) * [ci] yarn format * Added shiki to markdown-remark * Upgraded astro shiki * Added minimal example * Changed defaults to match <Code /> * Replace `shiki` with `astro` classes * Added documentation * Updated Astro code to use new `codeToHtml` * Added changesets * Added basic test * Updated tests a bit Co-authored-by: JuanM04 <JuanM04@users.noreply.github.com> 2022-01-31 17:14:07 -05:00
Remove docs from monorepo (#2517) * Remove docs from monorepo * Update PULL_REQUEST_TEMPLATE.md * Update relative doc references with links or todo 2022-02-07 13:39:53 -05:00			`This example showcases Astro's [built-in Markdown support](https://docs.astro.build/en/guides/markdown-content/).`
Add Shiki as an alternative to Prism (#2497) * [ci] yarn format * Added shiki to markdown-remark * Upgraded astro shiki * Added minimal example * Changed defaults to match <Code /> * Replace `shiki` with `astro` classes * Added documentation * Updated Astro code to use new `codeToHtml` * Added changesets * Added basic test * Updated tests a bit Co-authored-by: JuanM04 <JuanM04@users.noreply.github.com> 2022-01-31 17:14:07 -05:00
			- `src/pages/index.astro` uses Astro's `<Markdown>` component.
			- `src/pages/other.md` is a treated as a page entrypoint and uses a `layout`.