2.6 KiB
@astrojs/markdoc 📝
This Astro integration enables the usage of Markdoc to create components, pages, and content collection entries.
Why Markdoc?
Markdoc allows you to enhance your Markdown with UI components. If you have existing content authored in Markdoc, this integration allows you to bring those files to your Astro project.
Installation
Quick Install
The astro add command-line tool automates the installation for you. Run one of the following commands in a new terminal window. (If you aren't sure which package manager you're using, run the first command.) Then, follow the prompts, and type "y" in the terminal (meaning "yes") for each one.
# Using NPM
npx astro add markdoc
# Using Yarn
yarn astro add markdoc
# Using PNPM
pnpm astro add markdoc
If you run into any issues, feel free to report them to us on GitHub and try the manual installation steps below.
Manual Install
First, install the @astrojs/markdoc package using your package manager. If you're using npm or aren't sure, run this in the terminal:
npm install @astrojs/markdoc
Then, apply this integration to your astro.config.* file using the integrations property:
astro.config.mjs
import { defineConfig } from 'astro/config';
import markdoc from '@astrojs/markdoc';
export default defineConfig({
// ...
integrations: [markdoc()],
});
Usage
TODO
Configuration
TODO
Examples
TODO
Troubleshooting
For help, check out the #support channel on Discord. Our friendly Support Squad members are here to help!
You can also check our Astro Integration Documentation for more on integrations.
Contributing
This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!
Changelog
See CHANGELOG.md for a history of changes to this integration.