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.2.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.2-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for mkdocs_gitlab_wiki_edit_url-0.0.2.tar.gz
Algorithm Hash digest
SHA256 0eab164b331da43e23e779290c6099824046c11884f99ec8c00ce9569d9cbb9e
MD5 7d77a0beb9c37a86a3aa64a808e0d767
BLAKE2b-256 b4650c7da4ed6d98bb3be7b7da1260b0ef7ad84fd549bfddf80b11b0198597b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_gitlab_wiki_edit_url-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ad75db79931fcc4d2830ebd84692c01e9c35520626200d39fa6e10e13f2cec32
MD5 60bce863e86ce44bc382a3442a4f64bb
BLAKE2b-256 d08da6d38616389f9187066ad0f608676ccebca64f6b8b2f304b9da2c22c4890

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