Get started with Markdoc
Follow the instructions below to install Markdoc in your app. Or check out our integration guide to help you build a documentation site.
Install Markdoc
Install the Markdoc library:
npm install @markdoc/markdoc
or
yarn add @markdoc/markdoc
Import Markdoc
Import the Markdoc library in your app:
const Markdoc = require('@markdoc/markdoc');
If you're using ESM:
import Markdoc from '@markdoc/markdoc';
Use Markdoc
Call the parse, transform and render Markdoc functions to render your content.
const source = '# Markdoc'; const ast = Markdoc.parse(source); const content = Markdoc.transform(ast, /* config */); const html = Markdoc.renderers.html(content);
Next steps
xxxxxxxxxx1
57
---title: Get started with Markdocdescription: How to get started with Markdoc---# {% $markdoc.frontmatter.title %}Follow the instructions below to install Markdoc in your app. Or check out our [integration guide](/docs/nextjs) to help you build a documentation site. ## Install MarkdocInstall the Markdoc library:```shellnpm install @markdoc/markdoc```or```shellyarn add @markdoc/markdoc```## Import MarkdocImport the Markdoc library in your app:```jsconst Markdoc = require('@markdoc/markdoc');```If you're using ESM:```jsimport Markdoc from '@markdoc/markdoc';```## Use MarkdocCall the `parse`, `transform` and `render` Markdoc functions to render your content.```jsconst source = '# Markdoc';const ast = Markdoc.parse(source);{% comment %}// prettier-ignore{% /comment %}const content = Markdoc.transform(ast, /* [config](/docs/syntax#config) */);const html = Markdoc.renderers.html(content);```## Next steps- [Learn Markdoc syntax](/docs/syntax)