https://github.com/cliffcrerar/docz-quick-starter

Pre configured fresh Docz app that is immediately deployable.
https://github.com/cliffcrerar/docz-quick-starter

documentation-generator documentation-site documentation-tool docz dotenv mark-down mdx next nextjs react react-dom reactjs snyk theming

Last synced: 6 days ago
JSON representation

Pre configured fresh Docz app that is immediately deployable.

• Host: GitHub
• URL: https://github.com/cliffcrerar/docz-quick-starter
• Owner: CliffCrerar
• License: mit
• Created: 2019-06-28T21:46:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-23T01:53:46.000Z (7 months ago)
• Last Synced: 2024-10-28T14:45:52.253Z (17 days ago)
• Topics: documentation-generator, documentation-site, documentation-tool, docz, dotenv, mark-down, mdx, next, nextjs, react, react-dom, reactjs, snyk, theming
• Language: JavaScript
• Homepage: https://docz-quick-starter.c1i44.now.sh
• Size: 1.96 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Docz quick start

![GitHub issues](https://img.shields.io/github/issues/CliffCrerar/Docz-quick-starter.svg)

![GitHub forks](https://img.shields.io/github/forks/CliffCrerar/Docz-quick-starter.svg)

![GitHub stars](https://img.shields.io/github/stars/CliffCrerar/Docz-quick-starter.svg)

![GitHub license](https://img.shields.io/github/license/CliffCrerar/Docz-quick-starter.svg)

![GitHub downloads](https://img.shields.io/github/downloads/CliffCrerar/Docz-quick-starter/total.svg)

[![Known Vulnerabilities](https://snyk.io//test/github/CliffCrerar/Docz-quick-starter/badge.svg?targetFile=package.json)](https://snyk.io//test/github/CliffCrerar/Docz-quick-starter?targetFile=package.json)

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

![docz-quick-starter](https://cdn-docz-quick-starter.c1i44.now.sh/lpi-02.png)

---

* 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

```bash

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](https://docz-quick-starter.c1i44.now.sh). 

[Docz Official](https://www.docz.site/)

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](https://github.com/pedronauck) who created [docz](https://github.com/pedronauck/docz).