60 lines
2.4 KiB
Markdown
60 lines
2.4 KiB
Markdown
|
# Astro Example: Markdoc (experimental)
|
||
|
|
|
||
|
|
This starter showcases the experimental Markdoc integration.
|
||
|
|
|
||
|
|
```
|
||
|
|
npm create astro@latest -- --template with-markdoc
|
||
|
|
```
|
||
|
|
|
||
|
|
[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/with-markdoc)
|
||
|
|
[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/with-markdoc)
|
||
|
|
|
||
|
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||
|
|
|
||
|
|
## 🚀 Project Structure
|
||
|
|
|
||
|
|
Inside of your Astro project, you'll see the following folders and files:
|
||
|
|
|
||
|
|
```
|
||
|
|
/
|
||
|
|
├── public/
|
||
|
|
├── src/
|
||
|
|
│ └── content/
|
||
|
|
└── docs/
|
||
|
|
│ └── intro.mdoc
|
||
|
|
| └── config.ts
|
||
|
|
│ └── components/
|
||
|
|
| ├── Aside.astro
|
||
|
|
│ └── DocsContent.astro
|
||
|
|
│ └── layouts/
|
||
|
|
│ └── Layout.astro
|
||
|
|
│ └── pages/
|
||
|
|
│ └── index.astro
|
||
|
|
| └── env.d.ts
|
||
|
|
├── astro.config.mjs
|
||
|
|
├── README.md
|
||
|
|
├── package.json
|
||
|
|
└── tsconfig.json
|
||
|
|
```
|
||
|
|
|
||
|
|
Markdoc (`.mdoc`) files can be used in content collections to author your Markdown content alongside Astro and server-rendered UI framework components (React, Vue, Svelte, and more). See `src/content/docs/` for an example file.
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## 🧞 Commands
|
||
|
|
|
||
|
|
All commands are run from the root of the project, from a terminal:
|
||
|
|
|
||
|
|
| Command | Action |
|
||
|
|
| :--------------------- | :----------------------------------------------- |
|
||
|
|
| `npm install` | Installs dependencies |
|
||
|
|
| `npm run dev` | Starts local dev server at `localhost:3000` |
|
||
|
|
| `npm run build` | Build your production site to `./dist/` |
|
||
|
|
| `npm run preview` | Preview your build locally, before deploying |
|
||
|
|
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||
|
|
| `npm run astro --help` | Get help using the Astro CLI |
|
||
|
|
|
||
|
|
## 👀 Want to learn more?
|
||
|
|
|
||
|
|
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
|