Skip to content
/ docs Public

Documentation site for Markdoc

License

Notifications You must be signed in to change notification settings

markdoc/docs

Repository files navigation

Markdoc docs

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.

Contributing

Contributions and feedback are welcomed and encouraged. Feel free to open PRs here, or open issues in the Markdoc core repo.

Installation

  1. Fork and clone this repository to your local environment.

  2. Create a new branch with git checkout -b <BRANCH_NAME>

  3. Install the dependencies by running npm install

  4. Start the development server on http://localhost:3000 by running npm run dev

  5. Try editing pages/index.md

Code of conduct

This project has adopted the Stripe Code of conduct.

License

This project uses the MIT license.