docz

(★ 23,584)

✍ It has never been so easy to document your things!

File Explorer

Download Latest Version (.zip)
  • .all-contributorsrc
  • .commitlintrc.json
  • .editorconfig
  • .eslintignore
  • .gitignore
  • .huskyrc
  • .prettierignore
  • .prettierrc
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • lerna.json
  • LICENSE.md
  • MIGRATION_GUIDE.md
  • package.json
  • README.md
  • tsconfig.json
  • yarn.lock

# Installation Guide

1. Get the code
git clone https://github.com/pedronauck/docz

Downloads the entire project code from GitHub to your computer.

cd docz

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
$ yarn add docz # react react-dom

Type this command into your terminal and run it.

$ npm install docz # react react-dom

Downloads and installs the libraries listed in package.json.

yarn docz dev

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

Today's picks

react-native ★ 126,357

A framework for building native applications using React

C++
fzf ★ 82,545

:cherry_blossom: A command-line fuzzy finder

Go
mall ★ 84,558

mall项目是一套电商系统，包括前台商城系统及后台管理系统，基于Spring Boot+MyBatis实现，采用Docker容器化部署。 前台商城系统包含首页门户、商品推荐、商品搜

Java
awesome-for-beginners ★ 88,433

A list of awesome beginners-friendly projects.
papers-we-love ★ 108,787

Papers from the computer science community to read and discuss.

Shell
open-design ★ 87,459

🎨 Best DeepSeek Harness Design Plugin. The open-source Claude Design alternative. 🖥️ Local

TypeScript
// repository documentation