Docz quick start
Quickly start using docs with this preconfigured instance of docz, no need to have to ruffle through the config documents.
- You are comfortable using the
node package manager
npm
in the command line environment. - You have a understanding of how to use markdown.
- (Optional) You know how to use
React
, altoughdocz
is built on a.mdx
framework, knowing how to use react will help you to create more dynamic content, you will be able to use it just fine writingmdx
only.
Creating instance of docs
git clone https://github.com/CliffCrerar/Docz-quick-starter.gitcd Docz-quick-starternpm installnpm start
When npm start
is run the browser should pop open with your shiny new docz instance.
See the example app here.
If you are wondering where the rest is, this is a documents app so the rest of your questions will be answered once you have the app running.
Special thanks
Thanks to the effors of Pedro Nauck who created docz.