https://github.com/markdoc/docs

Documentation site for Markdoc
https://github.com/markdoc/docs

docs documentation markdoc

Last synced: about 1 month ago
JSON representation

Documentation site for Markdoc

• Host: GitHub
• URL: https://github.com/markdoc/docs
• Owner: markdoc
• License: mit
• Created: 2022-03-02T17:13:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-03T16:36:49.000Z (3 months ago)
• Last Synced: 2024-07-10T20:19:58.371Z (2 months ago)
• Topics: docs, documentation, markdoc
• Language: JavaScript
• Homepage: https://markdoc.dev/docs
• Size: 502 KB
• Stars: 128
• Watchers: 5
• Forks: 165
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Markdoc docs

[Markdoc](https://markdoc.dev) is a [Markdown](https://commonmark.org)-based syntax and toolchain for creating custom documentation sites and experiences.

We designed Markdoc to power [Stripe's public docs](http://stripe.com/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](https://github.com/markdoc/markdoc).

## Installation

1. [Fork](https://help.github.com/articles/fork-a-repo) and [clone](https://help.github.com/articles/cloning-a-repository) this repository to your local environment.

2. Create a new branch with `git checkout -b `

3. Install the dependencies by running `npm install`

4. Start the development server on [http://localhost:3000](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](https://github.com/markdoc/markdoc/blob/main/.github/CODE_OF_CONDUCT.md).

## License

This project uses the [MIT license](LICENSE).