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

# Astro Example: Markdown with Shiki

```sh
npm create astro@latest -- --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)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdown-shiki)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-markdown-shiki/devcontainer.json)

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

- `src/pages/index.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 19:14:07 -03:00			`# Astro Example: Markdown with Shiki`

Fix: lang unspecified code blocks (#8461) 2023-09-11 13:45:21 +02:00			```sh
.md only: npm init astro --> npm create astro (#4760) * .md only: npm init astro --> npm create astro For consistency with https://github.com/withastro/docs/pull/360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm\|yarn\|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in https://github.com/withastro/astro/pull/3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com> 2022-09-16 10:40:06 -07:00			`npm create astro@latest -- --template 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 19:14:07 -03:00			```

fix(examples): incorrect StackBlitz demo URLs (#3584) 2022-06-13 18:22:20 +02: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)`
Update open with codesandbox link to use synced sandboxes (#6105) 2023-02-03 17:52:11 +00:00			`[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdown-shiki)`
Fixes example README links to open in codespaces (#6346) 2023-02-23 10:20:19 -07:00			`[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/with-markdown-shiki/devcontainer.json)`
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 19:14:07 -03: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 19:14:07 -03:00
Move the Markdown component to its own package (#3986) * Move the Markdown component to its own package * Update the examples * Updated lockfile * Use is:raw * Add a main field * Update the formatting of the readme * Rename to @astrojs/markdown-component 2022-07-20 16:45:05 -04:00			- `src/pages/index.md` is a treated as a page entrypoint and uses a `layout`.