https://github.com/kagal-dev/tsdoc
https://github.com/kagal-dev/tsdoc
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/kagal-dev/tsdoc
- Owner: kagal-dev
- License: mit
- Created: 2026-04-15T17:35:54.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-06-06T01:43:17.000Z (14 days ago)
- Last Synced: 2026-06-06T03:14:14.086Z (14 days ago)
- Language: TypeScript
- Size: 145 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# tsdoc
Monorepo for TSDoc extraction and Nuxt consumption of
`@kagal/*` package API documentation.
## Packages
| Package | Description |
| --- | --- |
| [`@kagal/build-tsdoc`](packages/@kagal-build-tsdoc) | Build-hook adapter for `@microsoft/api-extractor`. Each entry's rolled declarations get a `.api.json` written next to them. |
| [`@kagal/nuxt-tsdoc`](packages/@kagal-nuxt-tsdoc) | Nuxt module that consumes `*.api.json` manifests produced by `@kagal/build-tsdoc`. |
The two packages form a pipeline: `@kagal/build-tsdoc`
extracts documentation at package build time and ships
`dist/.api.json` alongside the bundle;
`@kagal/nuxt-tsdoc` is the Nuxt consumer for those
manifests.
## Origin
`@kagal/build-tsdoc` was extracted from the
[`kagal-dev/pki`](https://github.com/kagal-dev/pki)
monorepo so it can be paired with its Nuxt consumer
and evolve independently of the PKI codebase.
## Common commands
```bash
pnpm install
pnpm build # Build all packages
pnpm clean # Remove dist/ and node_modules
pnpm dev:prepare # Stub all packages (unbuild --stub)
pnpm test # Test all packages
pnpm lint # Lint all (root + packages)
pnpm type-check # Type-check root tools + packages
pnpm precommit # dev:prepare → lint → type-check → build → test
pnpm prepack # lint:root:check → per-package prepack
```
Per-package commands via `--filter`:
```bash
pnpm --filter @kagal/build-tsdoc build
pnpm --filter @kagal/build-tsdoc test
```
## Licence
[MIT](LICENCE.txt)