mkdocstrings-typescript
A Typescript handler for mkdocstrings.
WARNING: Still in prototyping phase! Feedback is welcome.
Installation
pip install mkdocstrings-typescript
Usage
Add these TypeDoc configuration files to your repository:
./
src/
package1/
typedoc.base.json
typedoc.json
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true
}
{
"extends": ["./typedoc.base.json"],
"entryPointStrategy": "packages",
"entryPoints": ["./src/*"]
}
Update the entrypoints to match your file layout so that TypeDoc can find your packages. See TypeDoc's configuration documentation.
Then in each of your package, add this TypeDoc configuration file:
./
src/
package1/
typedoc.json
typedoc.base.json
typedoc.json
{
"extends": ["../../typedoc.base.json"],
"entryPointStrategy": "expand",
"entryPoints": ["src/index.d.ts"]
}
Again, update entrypoints to match your file and package layout. See TypeDoc's configuration documentation.
Your packages must be built for TypeDoc to work.
You are now able to use the TypeScript handler to inject API docs in your Markdown pages by referencing package names:
::: @owner/packageName
handler: typescript
You can set the Typescript handler as default handler:
plugins:
- mkdocstrings:
default_handler: typescript
By setting it as default handler you can omit it when injecting documentation:
::: @owner/packageName
Sponsors
Metadata
Release files for mkdocstrings-typescript 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocstrings_typescript-0.1.1.tar.gz | 43.2 kB | Without provenance | Details for mkdocstrings_typescript-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocstrings_typescript-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for mkdocstrings_typescript-0.1.1-py3-none-any.whl |
Total release size: 77.7 kB
Release files / mkdocstrings_typescript-0.1.1.tar.gz
| Download URL | mkdocstrings_typescript-0.1.1.tar.gz |
|---|---|
| Size | 43.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f4845723ad9e3254440361bc17f52317c70dc361fdbf5b24d2c9095bfe5c05f
|
|
BLAKE2b-256 checksum How to use checksums |
7b431a64380990e673d74534433c2b3f2c20566c1ccc0d7a480715093cb9f886
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / mkdocstrings_typescript-0.1.1-py3-none-any.whl
| Download URL | mkdocstrings_typescript-0.1.1-py3-none-any.whl |
|---|---|
| Size | 34.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
df79ab8f095ddf141726089ebb4e4f9f9d0552a81d52a520096544e3ddf5af3a
|
|
BLAKE2b-256 checksum How to use checksums |
ad29b53b59e210e10a2b1b7efb5faa86115dd145125b060a8929115f8a8554c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Security for mkdocstrings-typescript 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.