@urbit/markdoc
v0.1.6
Published
A text markup language for documentation
Downloads
7
Maintainers
Keywords
Readme
Markdoc is a Markdown-based syntax and toolchain for creating custom documentation sites and experiences.
We designed Markdoc to power Stripe's public docs, our largest and most complex content site.
Installation
To get started with Markdoc, first install the library:
npm install @markdoc/markdoc
or
yarn add @markdoc/markdoc
and import it in your app:
const Markdoc = require('@markdoc/markdoc');
or if you are using ESM
import Markdoc from '@markdoc/markdoc';
then use Markdoc
in your app or tool:
const doc = `
# Markdoc README
{% image src="/logo.svg" /%}
`;
const ast = Markdoc.parse(doc);
const content = Markdoc.transform(ast);
return Markdoc.renderers.react(content, React);
Check out our docs for more guidance on how to use Markdoc.
Contributing
Contributions and feedback are welcome and encouraged. Check out our contributing guidelines on how to do so.
Development
- Run
npm install
- Run
npm run build
- Run the tests using
npm test
Code of conduct
This project has adopted the Stripe Code of conduct.
License
This project uses the MIT license.
Credits
Special shout out to:
- @marcioAlmada for providing us with the @markdoc GitHub org.
- @koomen for gifting us https://markdoc.dev.