michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: update example README

Browse source
This commit is contained in:
bholmesdev 2023-02-13 18:08:07 -05:00
parent 1ebea26bca
commit a756e75673
1 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
examples/with-markdoc/README.md
View file

@ -1,11 +1,13 @@
# Astro Starter Kit: Minimal # Astro Starter Kit: Markdoc (experimental)
This starter showcases the experimental Markdoc integration.
``` ```
npm create astro@latest -- --template minimal npm create astro@latest -- --template with-markdoc
``` ```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdoc)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal) [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdoc)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! > 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
@ -17,16 +19,18 @@ Inside of your Astro project, you'll see the following folders and files:
/ /
├── public/ ├── public/
├── src/ ├── src/
│ └── content/docs/
│ └── intro.mdoc
│ └── components/
│ └── DocsContent.astro
│ └── pages/ │ └── pages/
│ └── index.astro │ └── index.astro
└── package.json └── package.json
``` ```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. Markdoc can be used within content collection using the `.mdoc` extension. See `content/docs/` for an example.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. You can also apply Astro components and server-rendered UI components (React, Vue, Svelte, etc) to your Markdoc files. See `src/content/DocsContent.astro` for an example configuration.
Any static assets, like images, can be placed in the `public/` directory.
## 🧞 Commands ## 🧞 Commands