Docz makes it easy to write and publish beautiful interactive documentation for your code. Create MDX files showcasing your code and Docz turns them into a live-reloading, production-ready site. Documenting code is one of the most important and time-consuming tasks when developing software. A lot of time is spent on building and maintaining custom documentation sites. Docz enables you to quickly create a live-reloading, SEO-friendly, production-ready documentation site with MDX and customize the look, feel and behave when required by leveraging GatsbyJS and Gatsby theme shadowing. There's a create-docz-app, which you can use to start new projects with docz even faster. This app is developed independently of the docz project, and is not officially supported. So use the app at your own risk. You can use create-docz-app as a replacement for create-react-app when you're creating a new project.
Features
- Start by adding docz as a dependency to your project with Yarn or npm
- Create .mdx files anywhere in your project
- Button component Button.jsx
- yarn docz build generates a static site in .docz/dist/
- The output of docz consists of static assets only
- You can have yarn docz build emit to a different directory
Project Samples
