astro/examples/with-markdown-shiki
Juan Martín Seery 6fe1b0279f
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 16:14:07 -06:00
..
public Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
src Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
.gitignore Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
.npmrc Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
.stackblitzrc Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
astro.config.mjs Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
package.json Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
README.md Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
sandbox.config.json Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00
tsconfig.json Add Shiki as an alternative to Prism (#2497) 2022-01-31 16:14:07 -06:00

Astro Example: Markdown with Shiki

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

Open in StackBlitz

This example showcases Astro's built-in Markdown support.

  • src/pages/index.astro uses Astro's <Markdown> component.
  • src/pages/other.md is a treated as a page entrypoint and uses a layout.