mirror of https://github.com/nbtca/documents.git synced 2026-09-19 23:06:10 +08:00

TypeScript 62.9%
Vue 24.2%
CSS 10.2%
JavaScript 2.7%

Find a file

小明 e9dbc62509 Merge pull request #176 from nbtca/docs/sheepkinn docs(archived):record the 2026-09-16-club-recruitment-fair-prep-meeti…		2026-09-18 17:39:53 +08:00
.github	ci: run the checks on every pull request, not only those targeting main	2026-09-07 14:32:33 +08:00
.husky	Docs overhaul: restructure, expand, and standardize (#105 )	2026-04-28 23:11:44 +08:00
.vitepress	feat(editor): file a new record in the archive, and write like GitHub	2026-09-18 09:37:45 +08:00
.vscode	eslint	2025-04-03 19:36:44 +08:00
about	docs(nav): sort the guide by what a page is for, not by habit	2026-09-09 16:58:43 +08:00
archived	fix: resolve lint issues in recruitment meeting record	2026-09-18 17:33:19 +08:00
checks	fix(checks): stop reading link syntax inside code spans as links	2026-09-09 16:53:39 +08:00
concepts	docs: transcribe the 2007-2025 archive, and correct what it contradicts	2026-08-27 13:47:58 +08:00
functions/api/auth	fix(editor): branch from what the writer read, not from the tip	2026-09-08 14:30:17 +08:00
process/2025	docs(nav): sort the guide by what a page is for, not by habit	2026-09-09 16:58:43 +08:00
public	docs(nav): sort the guide by what a page is for, not by habit	2026-09-09 16:58:43 +08:00
repair	chore(assets): convert documentation screenshots to webp	2026-08-29 10:39:39 +08:00
scripts	refactor: separate what builds the site from what checks it	2026-08-29 10:51:31 +08:00
tutorial	docs: add the caveats the house marks with a callout	2026-09-09 17:35:42 +08:00
utils	refactor: drop dead navigation exports and stop preloading a diagram chunk	2026-09-08 16:03:38 +08:00
.gitignore	fix(tooling): track docs/ and stop publishing governance docs	2026-06-15 17:01:47 +08:00
.markdownlint-cli2.jsonc	docs: transcribe the 2007-2025 archive, and correct what it contradicts	2026-08-27 13:47:58 +08:00
.nvmrc	Strengthen CI dependency gates	2026-05-28 11:58:28 +08:00
callback.md	fix(editor): render the sign-in callback page	2026-09-07 11:51:07 +08:00
CONTRIBUTING.md	feat(editor): let a cohort maintain its own archive	2026-09-08 15:11:39 +08:00
eslint.config.mjs	refactor: separate what builds the site from what checks it	2026-08-29 10:51:31 +08:00
index.md	feat(platform): localize theme UI, fix CJK search, and cut page weight	2026-08-11 14:06:17 +08:00
package.json	feat(editor): sign in through GitHub itself, and open the pull request from a fork	2026-09-07 10:49:42 +08:00
pnpm-lock.yaml	feat(editor): sign in through GitHub itself, and open the pull request from a fork	2026-09-07 10:49:42 +08:00
README.md	Strengthen CI dependency gates	2026-05-28 11:58:28 +08:00
tsconfig.json	eslint	2025-04-03 19:36:44 +08:00

README.md

documents

Documents for nbtca.

How to use

Install dependencies

Install Node.js 22.21.1
Install pnpm 9.0.0
```
npm install -g pnpm
```
Install dependencies
```
pnpm install --frozen-lockfile
```

Start development server

pnpm docs:dev

Build for production

pnpm docs:build

Lint code

pnpm lint

Verify before pushing

Run the same checks as CI locally:

pnpm install --frozen-lockfile
pnpm test -- --run
pnpm run ci:lint
pnpm docs:build