astro/examples/with-markdoc/README.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

2023-02-14 14:07:29 +00:00
# Astro Example: Markdoc (experimental)
2023-02-13 23:08:07 +00:00
This starter showcases the experimental Markdoc integration.
```
2023-02-13 23:08:07 +00:00
npm create astro@latest -- --template with-markdoc
```
2023-02-13 23:08:07 +00:00
[![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/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/
2023-03-01 19:27:07 +00:00
│ └── content/
└── docs/
│ └── intro.mdoc
| └── config.ts
2023-02-13 23:08:07 +00:00
│ └── components/
2023-03-01 19:27:07 +00:00
| ├── Aside.astro
2023-02-13 23:08:07 +00:00
│ └── DocsContent.astro
2023-03-01 19:27:07 +00:00
│ └── layouts/
│ └── Layout.astro
│ └── pages/
│ └── index.astro
2023-03-01 19:27:07 +00:00
| └── env.d.ts
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json
```
2023-02-14 14:08:56 +00:00
Markdoc can be used in content collections with the `.mdoc` extension. See `content/docs/` for an example.
2023-03-01 19:27:07 +00:00
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).