{"id":19106796,"url":"https://github.com/cliffcrerar/docz-quick-starter","last_synced_at":"2026-05-04T15:34:08.854Z","repository":{"id":54155974,"uuid":"194337188","full_name":"CliffCrerar/Docz-quick-starter","owner":"CliffCrerar","description":"Pre configured fresh Docz app that is immediately deployable.","archived":false,"fork":false,"pushed_at":"2024-04-23T01:53:46.000Z","size":2055,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-03T20:07:38.565Z","etag":null,"topics":["documentation-generator","documentation-site","documentation-tool","docz","dotenv","mark-down","mdx","next","nextjs","react","react-dom","reactjs","snyk","theming"],"latest_commit_sha":null,"homepage":"https://docz-quick-starter.c1i44.now.sh","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CliffCrerar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-28T21:46:08.000Z","updated_at":"2019-09-01T04:26:35.000Z","dependencies_parsed_at":"2022-08-13T07:50:37.110Z","dependency_job_id":null,"html_url":"https://github.com/CliffCrerar/Docz-quick-starter","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliffCrerar%2FDocz-quick-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliffCrerar%2FDocz-quick-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliffCrerar%2FDocz-quick-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CliffCrerar%2FDocz-quick-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CliffCrerar","download_url":"https://codeload.github.com/CliffCrerar/Docz-quick-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240158874,"owners_count":19757259,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-generator","documentation-site","documentation-tool","docz","dotenv","mark-down","mdx","next","nextjs","react","react-dom","reactjs","snyk","theming"],"created_at":"2024-11-09T04:09:31.343Z","updated_at":"2025-10-15T04:52:02.767Z","avatar_url":"https://github.com/CliffCrerar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docz quick start\n\n![GitHub issues](https://img.shields.io/github/issues/CliffCrerar/Docz-quick-starter.svg)\n![GitHub forks](https://img.shields.io/github/forks/CliffCrerar/Docz-quick-starter.svg)\n![GitHub stars](https://img.shields.io/github/stars/CliffCrerar/Docz-quick-starter.svg)\n![GitHub license](https://img.shields.io/github/license/CliffCrerar/Docz-quick-starter.svg)\n![GitHub downloads](https://img.shields.io/github/downloads/CliffCrerar/Docz-quick-starter/total.svg)\n[![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)\n\n\u003e Quickly start using docs with this preconfigured instance of docz, no need to have to ruffle through the config documents.\n\n![docz-quick-starter](https://cdn-docz-quick-starter.c1i44.now.sh/lpi-02.png)\n\n---\n\n* You are comfortable using the `node package manager`  `npm` in the command line environment.\n* You have a understanding of how to use markdown.\n* *(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.\n\n## Creating instance of docs\n\n```bash\ngit clone https://github.com/CliffCrerar/Docz-quick-starter.git\ncd Docz-quick-starter\nnpm install\nnpm start\n```\n\nWhen `npm start` is run the browser should pop open with your shiny new docz instance.\n\nSee the example app [here](https://docz-quick-starter.c1i44.now.sh). \n\n[Docz Official](https://www.docz.site/)\n\nIf 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.\n\n## Special thanks\n\nThanks to the effors of [Pedro Nauck](https://github.com/pedronauck) who created [docz](https://github.com/pedronauck/docz).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcliffcrerar%2Fdocz-quick-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcliffcrerar%2Fdocz-quick-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcliffcrerar%2Fdocz-quick-starter/lists"}