Description:
mkdocsgitlinks 0.0.3
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
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
