Markdoc Markdown-Based Authoring Framework by Stripe
Markdoc is a powerful Markdown-based authoring framework created by Stripe to power their public documentation. It extends Markdown with custom tags, functions, and variables for building structured documentation sites and content experiences.
Installation
Use the upstream install or setup path that matches your environment:
- npm install @markdoc/markdoc
- yarn add @markdoc/markdoc
- npm install @markdoc/markdoc react @types/react
- Run npm install
Requirements and caveats from upstream:
- const Markdoc = require('@markdoc/markdoc');
- "moduleResolution": "node",
Basic usage or getting-started notes:
To get started with Markdoc, first install the library:
shell
or
Extracted from upstream docs: https://raw.githubusercontent.com/markdoc/markdoc/HEAD/README.md