Skip to main content

Use Edit URLs compatible with GitHub Wiki

Project description

MKDocs GitHub Wiki Edit Url Support

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

Install

  • Use pip install mkdocs-github-wiki-edit-url
  • Add the plugin to your mkdocs.yml, e.g.:
plugins:
  - search
  - ezlinks
  - 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-github-wiki-edit-url-0.4.tar.gz (1.8 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file mkdocs-github-wiki-edit-url-0.4.tar.gz.

File metadata

File hashes

Hashes for mkdocs-github-wiki-edit-url-0.4.tar.gz
Algorithm Hash digest
SHA256 7feb507a03023b3368054e451cbbeb89524094c5570d267b2478cf0218dcc2fa
MD5 85c288b7251fc00c3248f45d86152522
BLAKE2b-256 bcc9be4fb1f5dbcd2511befe7a15a2d4ea89023b2777d68c139b17424572656c

See more details on using hashes here.

File details

Details for the file mkdocs_github_wiki_edit_url-0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_github_wiki_edit_url-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a2f02af6343ab2a1d29f32e58d2bc65e62ac3838f33fb754fd4bf2f083d99b37
MD5 0aaf57f26f6546590f0aac56b83d369f
BLAKE2b-256 1c49d2a3bff7cb4574236e6423e3a055b0be5ee75dd5fdb7fe37e004a6563080

See more details on using hashes here.

Supported by

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