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.3.tar.gz (1.4 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for mkdocs-github-wiki-edit-url-0.3.tar.gz
Algorithm Hash digest
SHA256 53e77c6b0cb0ed495d6c1d28d8829a7162b0cd75dd9133a4208e6254d4f4b3b3
MD5 bda8088c66320a517fb0725804ebc4cd
BLAKE2b-256 aa3c0220ff392cf332c861bb9901bf99ce02aa5510463a5c7915e8ecb5bea4ed

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_github_wiki_edit_url-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d631d4371db38a03a9d7a59e86f8c380aad10119a7f57f1e9886b7d28950095b
MD5 a020b197db6db64283c6d68b990dc773
BLAKE2b-256 dd7cf1fc4590536b8414ea608e66e5e945a9d56fac4307778711815a4fa918f3

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