astro/examples/with-markdoc
Houston (Bot) 1efd51fb47
[ci] release (#8304)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2023-08-30 16:31:20 -04:00
..
.codesandbox Update CodeSandbox config for Node 18 and new editor (#8292) 2023-08-30 18:52:21 +02:00
.vscode @astrojs/markdoc (#6209) 2023-03-07 14:05:19 -05:00
public chore: update example favicons (#6487) 2023-03-09 11:23:47 -06:00
src [ci] format 2023-08-15 22:21:05 +00:00
.gitignore @astrojs/markdoc (#6209) 2023-03-07 14:05:19 -05:00
astro.config.mjs [Markdoc] New config format with runtime variable support! (#6653) 2023-03-27 18:04:37 -04:00
markdoc.config.mjs feat: New Markdoc render API (#7468) 2023-06-27 15:05:17 -04:00
package.json [ci] release (#8304) 2023-08-30 16:31:20 -04:00
README.md feat: change default port to 4321 (#7874) 2023-08-08 11:02:51 +01:00
tsconfig.json @astrojs/markdoc (#6209) 2023-03-07 14:05:19 -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
│   └── layouts/Layout.astro
│   └── pages/index.astro
|   └── env.d.ts
├── astro.config.mjs
├── markdoc.config.mjs
├── README.md
├── package.json
└── tsconfig.json

Markdoc (.mdoc) files can be used in content collections. See src/content/docs/ for an example file.

You can also render Astro components from your Markdoc files using tags. See the markdoc.config.mjs file for an example configuration.

🧞 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:4321
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.