Mkdocs Gitlinks
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mkdocs_gitlinks-0.0.3.tar.gz
(5.6 kB
view hashes)
Built Distribution
Close
Hashes for mkdocs_gitlinks-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f95b2fe2899e32843387b543a85f8fb6f5afea4bded1cb6a406b053b2480db3 |
|
MD5 | 463ab4236f3aa71e19e10e3e3cd3d5ce |
|
BLAKE2b-256 | 4d2cdca7942589d4ed1983ea5abbe45882c37de49a81a3bf070d9b53a74fe27b |