Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

docz-quick-start

1.2.1 • Public • Published

Docz quick start

GitHub issues GitHub forks GitHub stars GitHub license GitHub downloads

Quickly start using docs with this preconfigured instance of docz, no need to have to ruffle through the config documents.

docz-quick-starter


  • 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 , altough docz 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 writing mdx only.

Creating instance of docs

git clone https://github.com/CliffCrerar/Docz-quick-starter.git
cd Docz-quick-starter
npm install
npm start

When npm start is run the browser should pop open with your shiny new docz instance.

See the example app here.

Docz Official

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.

Install

npm i docz-quick-start

DownloadsWeekly Downloads

0

Version

1.2.1

License

MIT

Unpacked Size

31.1 kB

Total Files

12

Last publish

Collaborators

  • avatar