docs-site-builder

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

docs-site-builder

★ 11 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Docs Site Builder

![CI](https://img.shields.io/github/actions/workflow/status/OWNER/docs-site-builder/ci.yml?branch=main&label=build)
![Release](https://img.shields.io/github/v/release/OWNER/docs-site-builder?label=release)
![License](https://img.shields.io/github/license/OWNER/docs-site-builder)
![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)

> A static site generator that turns a /docs folder into a searchable documentation website.

## Install

```bash
git clone https://github.com/OWNER/docs-site-builder.git
cd docs-site-builder
bash scripts/setup.sh
```

## Usage

```bash
npm start -- --source docs --out site
```

```bash
npm start -- --source docs --out site --serve
```

Run `npm start -- --help` for the full CLI reference.

## npm scripts

| Script | What it does |
|---|---|
| `npm start` | Runs the core CLI (`src/docs-site-builder.js`) |
| `npm test` | Runs the test suite |
| `npm run tracker` | Shows achievement badge progress |
| `npm run roadmap` | Shows the Day 1 → Month 1 roadmap |
| `npm run setup` | Checks dependencies, makes scripts executable |

## Automation scripts (`scripts/`)

| Script | What it does |
|---|---|
| `setup.sh` | Checks Node/gh dependencies, installs npm packages, chmods scripts |
| `quickdraw.sh` | Opens and closes a GitHub issue in under 5 minutes |
| `yolo.sh` | Creates a branch, opens a PR, merges it without review |
| `publicist.sh` | Creates a `v1.0.0` GitHub Release |
| `pull-shark.sh <count>` | Merges `<count>` PRs — `2`=Bronze, `16`=Silver, `128`=Gold |
| `pair-extraordinaire.sh "Name" "email"` | Creates a co-authored, merged PR |
| `unlock-all.sh` | Interactive menu for all of the above, plus a "Full Blast" run-everything option |

All scripts check `gh auth status` first and print a fix if you're not authenticated, auto-detect the current repo via `gh repo view`, and use timestamps so branch/tag names never collide.

## Codespaces

This repo ships a `.devcontainer/devcontainer.json` that installs Node 20 and the GitHub CLI automatically — just click **Code → Codespaces → Create codespace**.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

[MIT](LICENSE)

docs-site-builder

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README