MKDocs Gitlinks

This is a simple plugin for MKDocs that creates links to git projects easier.

Usage

To use the plugin you need to set it up

Config

In the mkdocs.yml add:

plugins:
  - mkdocs_gitlinks:

Markdown

Then in the markdown you can link to git projects (currently only Github is supported) by using the syntax below:

[github](orginisation/project)

For example to link to this project use:

[github](umaaz/mkdocs_gitlinks)

Output

The result of this is to change the link to:

Options

There are a few options available

plugins:
  - mkdocs_gitlinks:
      show_docs: false # setting this to true will include a link to the github pages for the project
      github_host: github.com # this allows for changing the github host name

Metadata

Release files for mkdocs-gitlinks 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-gitlinks 0.0.3
File	Size	Uploaded	Provenance
mkdocs_gitlinks-0.0.3.tar.gz	5.6 kB	Sep 6, 2023	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-gitlinks 0.0.3
File	Interpreter	ABI	Platform	Reset
mkdocs_gitlinks-0.0.3-py3-none-any.whl 4.5 kB Sep 6, 2023 Without provenance	Python 3	none	any	Details

Total release size: 10.1 kB

Release files / mkdocs_gitlinks-0.0.3.tar.gz

Download URL	mkdocs_gitlinks-0.0.3.tar.gz
Size	5.6 kB
Tags	Source
SHA-256 checksum How to use checksums	`98b80bfb8c99d3cb663ca15c9163b216129108edaa3e3c2bf28637c6bb3593f8`
BLAKE2b-256 checksum How to use checksums	`60e577ad043cdb0403d650cc3b221e02182912051c9f7503359a282233b00733`
Upload date	Sep 6, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.4`

Release files / mkdocs_gitlinks-0.0.3-py3-none-any.whl

Download URL	mkdocs_gitlinks-0.0.3-py3-none-any.whl
Size	4.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`8f95b2fe2899e32843387b543a85f8fb6f5afea4bded1cb6a406b053b2480db3`
BLAKE2b-256 checksum How to use checksums	`4d2cdca7942589d4ed1983ea5abbe45882c37de49a81a3bf070d9b53a74fe27b`
Upload date	Sep 6, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.4`

Security for mkdocs-gitlinks 0.0.3

Report project as malware

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.