Just my personal choices:
- ts-check to check types in JSDoc comments
- eslint with seven rules
- prettier with default configuration
- lefthook to run
- 0BSD license
- no package.json
- Node.js (tested on 12)
- GNU make or BSD make
- TypeScript (tested on 3.7) and ESLint
- Prettier and lefthook
- vscode or any other IDEs/editors supporting ESLint and TypeScript with JSDoc commented types
git clone https://github.com/weakish/js.git cd js make install-deps # install dependencies make # packaging with ncc
- Simple (97 CLOC) and lightweight (1380kB compiled as a single file).
- No statically built html files.
- Zero configuration.
index.js file at GitHub releases page, and put it under your documentation directory with markdown files.
Now just run
node index.js and you can access your documentation site at http://127.0.0.1:3000
Suppose you run
node index.js under
docs directory, then:
docs/README.md => http://127.0.0.1:3000 docs/guide.md => http://127.0.0.1:3000/guide/ docs/zh-cn/README.md => http://127.0.0.1:3000/zh-cn/ docs/zh-cn/guide.md => http://127.0.0.1:3000/zh-cn/guide/