diff options
| author |  Juan MartÃn Seery <me@juanm04.com>
| 2022-01-31 19:14:07 -0300 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-01-31 16:14:07 -0600 |
| commit | 6fe1b0279fce5a7a0e90ff79746ea0b641da3e21 (patch) | |
| tree | c2924bfd3e2c131d135cc8b2ceecbec310c6be56 /examples/with-markdown-shiki/README.md | |
| parent | 618a16f59d4037cff1665110f0ed111a96a96437 (diff) | |
| download | astro-6fe1b0279fce5a7a0e90ff79746ea0b641da3e21.tar.gz astro-6fe1b0279fce5a7a0e90ff79746ea0b641da3e21.tar.zst astro-6fe1b0279fce5a7a0e90ff79746ea0b641da3e21.zip | |
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>
Diffstat (limited to 'examples/with-markdown-shiki/README.md')
| -rw-r--r-- | examples/with-markdown-shiki/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/examples/with-markdown-shiki/README.md b/examples/with-markdown-shiki/README.md new file mode 100644 index 000000000..d97d1855d --- /dev/null +++ b/examples/with-markdown-shiki/README.md @@ -0,0 +1,12 @@ +# Astro Example: Markdown with Shiki + +``` +npm init astro -- --template with-markdown-shiki +``` + +[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdown) + +This example showcases Astro's [built-in Markdown support](../../docs/markdown.md). + +- `src/pages/index.astro` uses Astro's `<Markdown>` component. +- `src/pages/other.md` is a treated as a page entrypoint and uses a `layout`. |