Skip to content

Getting started with Insiders¤

mkdocstrings-typescript Insiders is a compatible drop-in replacement for mkdocstrings-typescript, and can be installed similarly using pip or git. Note that in order to access the Insiders repository, you need to become an eligible sponsor of @pawamoy on GitHub.

Installation¤

with the insiders tool¤

insiders is a tool that helps you keep up-to-date versions of Insiders projects in the PyPI index of your choice (self-hosted, Google registry, Artifactory, etc.).

We kindly ask that you do not upload the distributions to public registries, as it is against our Terms of use.

with pip (ssh/https)¤

mkdocstrings-typescript Insiders can be installed with pip using SSH:

pip install git+ssh://git@github.com/pawamoy-insiders/mkdocstrings-typescript.git

Or using HTTPS:

pip install git+https://${GH_TOKEN}@github.com/pawamoy-insiders/mkdocstrings-typescript.git
How to get a GitHub personal access token?

The GH_TOKEN environment variable is a GitHub token. It can be obtained by creating a personal access token for your GitHub account. It will give you access to the Insiders repository, programmatically, from the command line or GitHub Actions workflows:

  1. Go to https://github.com/settings/tokens
  2. Click on Generate a new token
  3. Enter a name and select the repo scope
  4. Generate the token and store it in a safe place

Note that the personal access token must be kept secret at all times, as it allows the owner to access your private repositories.

with Git¤

Of course, you can use mkdocstrings-typescript Insiders directly using Git:

git clone git@github.com:pawamoy-insiders/mkdocstrings-typescript

When cloning with Git, the package must be installed:

pip install -e mkdocstrings-typescript

Upgrading¤

When upgrading Insiders, you should always check the version of mkdocstrings-typescript which makes up the first part of the version qualifier. For example, a version like 8.x.x.4.x.x means that Insiders 4.x.x is currently based on 8.x.x.

If the major version increased, it's a good idea to consult the changelog and go through the steps to ensure your configuration is up to date and all necessary changes have been made.