Markdoc is a Markdown-based syntax and toolchain for creating custom documentation sites and experiences. Stripe designed Markdoc to power their public docs, their largest and most complex content site. We at CSX Labs admire the simplicity and rigor of Stripe's content docs, so we decided to use their markdoc framework for our organization's docs. We are not stripping this readme due to give proper credit to the people at Markdoc.
Contributions and feedback are welcomed and encouraged. Feel free to open PRs here, or open issues in the Markdoc core repo.
-
Create a new branch with
git checkout -b <BRANCH_NAME> -
Install the dependencies by running
npm install -
Start the development server on http://localhost:3000 by running
yarn run dev -
Try editing
pages/index.md
This project has adopted the Stripe Code of conduct.
The project structure and page style uses the MIT license, however all CSX Labs brand and content is intellectual property of CSX Labs, LLC.