When I wanted to write some documentation. Earlier I had used Jekyll with Github pages. Then I had to create all the stuff by hand. Now I am going to introduce Docz in 5 steps…
It’s never been easier to document your things!
- Powered by Gatsby
- Zero config
- Easy to customize
- Based on MDX
- Fully pluggable
- TypeScript support
Run following commands to setup it
npm init # Use `-y` to quick run
yarn add docz react react-dom
npm install docz react react-dom
3. Start dev build
yarn docz dev
npx docz dev
write this file to
-------- name: Hello world route: / -------- # Hello world Hello, I'm a mdx file!
https://localhost:3001 or what else printed in console.
Visit https://www.docz.site/ for more
Follow me for more articles.