user-avatar

Kyle J. Roux

jstacoder

Developer Program Member

a python/javascript/php/linux guru ready to take on the world...

CasePeer
orange, CA, USA
https://jstacoder.github.io

Hi
Home

Ez Doc Site With Docz

1 min read

Heres how to make an easy site with docz


Create a directory

$ mkdir my-project-docs
$ cd my-project-docs

but call it whatever you want.

Install Dependencies

$ yarn init -y
$ yarn add react react-dom gatsby gatsby-theme-docz@next docz@next

Now we only need to add 2 small files and were done:

gatsby-config.js - a configuration file, this is where we tell gatsby to use docz

some mdx file, we will start with our index/getting statrted page

gatsby-config.js
module.exports = {
plugins: [
`gatsby-theme-docz`
]
}
src/pages/index.mdx
---
name: Getting Started
route: /
menu:
---
## Here is our first doc page

Thats all you need, now you can check out your new website with:

$ gatsby develop

Go ahead see...

Comments
Home