Skip to main content

MkDocs plugin for using Edit URLs compatible with Gitlab Wiki

Project description

MKDocs Gitlab Wiki Edit Url Support

This plugin is to enable mkdocs to produce output that uses the Gitlab Wiki-style edit URL's, e.g. https://gitlab.com/project/repo/-/wikis/some/path?edit=true You will need to set repo_url to your wiki URL, e.g. https://gitlab.com/project/repo/wiki. The plugin will use repo_url/?edit=true as the URL style.

Install

  • Use pip install mkdocs-gitlab-wiki-edit-url
  • Add the plugin to your mkdocs.yml, e.g.:
plugins:
  - search
  - gitlab-wiki-edit-url

Origin

This plugin is inspired by and forked from mkdocs-github-wiki-edit-url.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_gitlab_wiki_edit_url-0.0.1.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_gitlab_wiki_edit_url-0.0.1-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_gitlab_wiki_edit_url-0.0.1.tar.gz.

File metadata

File hashes

Hashes for mkdocs_gitlab_wiki_edit_url-0.0.1.tar.gz
Algorithm Hash digest
SHA256 286e73ffbc3e4a6c1dfcc1063a5bf6c8049dfc5105c7d16513c60c6bc513a802
MD5 9db5d519d97bd0e0dc88c0a6cb5866e6
BLAKE2b-256 f94ca787e9eecf0163ba6f418665ad00cbaf590477f997ad2ee779f75685c630

See more details on using hashes here.

File details

Details for the file mkdocs_gitlab_wiki_edit_url-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_gitlab_wiki_edit_url-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ddb0aa3b0b03e8a3d3abb1be1a24c67958d5723f0c7876affc808f6708f41ccd
MD5 3f441c5e2c084b862b0462ba67a9f3f1
BLAKE2b-256 6d04542f6cbca251491de6e220979b872ba2a349d3003b70a7d01df44d0d27c4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page