hub / github.com/SimplrJS/ts-docs-gen
github.com/SimplrJS/ts-docs-gen @v0.2.0
Chat with this repo
465 symbols
714 edges
100 files
9 documented · 2%
● updated 7y agov0.2.0 · 2018-02-01★ 528 open issues
Browse by type
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
ts-docs-gen
Work in progress.
Markdown documentation generator for TypeScript projects.
Packages
| Package | Version | Description |
|---|---|---|
ts-docs-gen |
 |
Documentation generating tool |
Development
Latest published version should be in the master branch. Development is happening in the dev and feature branches.
Core Team
Martynas Žilinskas
|
Deividas Bakanas
|
Dovydas Navickas
|
Extension points exported contracts — how you extend this code
SerializedApiDefinition (Interface)
(no doc) [24 implementers]
packages/ts-docs-gen/src/contracts/serialized-api-item.ts
StringValidator (Interface)
(no doc) [4 implementers]
packages/ts-docs-gen/tests/cases/simple-project-3/src/split-namespace.ts
Start (Interface)
(no doc) [3 implementers]
packages/ts-docs-gen/tests/cases/simple-project-2/src/index.ts
Plugin (Interface)
(no doc) [2 implementers]
packages/ts-docs-gen/src/contracts/plugin.ts
ApiItemReferenceRegistry (Interface)
(no doc) [2 implementers]
packages/ts-docs-gen/src/contracts/api-item-reference-registry.ts
Core symbols most depended-on inside this repo
ToInlineText
called by 19
packages/ts-docs-gen/src/contracts/serialized-api-item.ts
flagName
called by 9
packages/ts-docs-gen/src/cli/arguments.ts
ToText
called by 6
packages/ts-docs-gen/src/contracts/serialized-api-item.ts
LogWithApiItemPosition
called by 4
packages/ts-docs-gen/src/generator-helpers.ts
Build
called by 4
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts
getKey
called by 3
packages/ts-docs-gen/src/registries/api-item-reference-registry.ts
resolveProjectDirectory
called by 3
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts
WriteToFiles
called by 2
packages/ts-docs-gen/src/generator.ts
Shape
Languages
TypeScript100%
Modules by API surface
packages/ts-docs-gen/tests/cases/simple-project-1/src/index.ts50 symbols
packages/ts-docs-gen/tests/cases/simple-project-2/src/foo.ts14 symbols
packages/ts-docs-gen/src/generator-helpers.ts14 symbols
packages/ts-docs-gen/src/file-manager.ts11 symbols
packages/ts-docs-gen/src/contracts/plugin.ts11 symbols
packages/ts-docs-gen/src/builders/generator-configuration-builder.ts11 symbols
packages/ts-docs-gen/src/api-items/api-definition-default.ts9 symbols
packages/ts-docs-gen/tests/cases/simple-project-3/src/split-namespace.ts8 symbols
packages/ts-docs-gen/src/contracts/serialized-api-item.ts8 symbols
packages/ts-docs-gen/src/api-items/api-definition-base.ts8 symbols
packages/ts-docs-gen/src/api-items/api-callable.ts8 symbols
packages/ts-docs-gen/tests/cases/simple-project-2/src/index.ts7 symbols
For agents
$ claude mcp add ts-docs-gen \
-- python -m otcore.mcp_server <graph>