astro/examples/with-markdoc
2023-03-03 08:51:43 -05:00
..
.vscode feat: basic Astro renderer in with-markdoc 2023-03-03 08:39:37 -05:00
public feat: basic Astro renderer in with-markdoc 2023-03-03 08:39:37 -05:00
src chore: update DocsContent comments 2023-03-03 08:51:43 -05:00
.gitignore feat: basic Astro renderer in with-markdoc 2023-03-03 08:39:37 -05:00
astro.config.mjs refactor: move markdoc transform to build time 2023-03-03 08:42:48 -05:00
package.json fix: lock 2023-03-03 08:39:41 -05:00
README.md docs: add "exclusively" to README 2023-03-03 08:42:48 -05:00
sandbox.config.json feat: basic Astro renderer in with-markdoc 2023-03-03 08:39:37 -05:00
tsconfig.json chore: with-markdoc strictNullChecks 2023-03-03 08:39:40 -05:00

Astro Example: Markdoc (experimental)

This starter showcases the experimental Markdoc integration.

npm create astro@latest -- --template with-markdoc

Open in StackBlitz Open with CodeSandbox

🧑‍🚀 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 can be used in content collections exclusively with the .mdoc extension. See 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 or jump into our Discord server.