No project description provided
Project description
mkdocs-caseinsensitive-plugin
This plugin allows you to link to case-insensitive documentation files.
Usecase
When presented with the following tree directory structure:
project
│ works_for_images.md (contains link to "folder1/IMAGE.PNG")
│ works_for_markdown.md (contains link to "FOLDER1/readme.md")
│
└───folder1
│ │ image.png
│ │ README.md
MkDocs will produce the following logging warning messages
WARNING - Documentation file 'works_for_images.md' contains a link to 'folder1/IMAGE.PNG' which is not found in the documentation files.
WARNING - Documentation file 'works_for_markdown.md' contains a link to 'FOLDER1/readme.md' which is not found in the documentation files.
Consequently, the rendered HTML files will not have the appropriate links in place.
This issue has been raised on the MkDocs repository before here. Understandably, this is desirable behaviour due to the differences in operating systems in how lax they are when it comes to case-sensitivity in files and directories.
Installation
Install the package with pip:
pip install mkdocs-caseinsensitive-plugin
TODO: Install the package from source with pip:
git clone https://github.com/TheMythologist/mkdocs-caseinsensitive-plugin.git
Enable the plugin in your mkdocs.yml
:
plugins:
- search: {}
- caseinsensitive: {}
NOTE: If you have no
plugins
entry in your configuration file yet, you'll likely also want to add thesearch
plugin. MkDocs enables it by default if there is noplugins
entry set, but now you have to enable it explicitly.
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
Built Distribution
Hashes for mkdocs_caseinsensitive_plugin-0.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 781b244a55ee36b68d3e634d9ba95fbe2c05a0ce3fa2b368721fa19ce75d1ca3 |
|
MD5 | 816fa5950fa88235ce382fbeac7433e1 |
|
BLAKE2b-256 | 39b70b4412eb099b801ec07ab685cd05e67e955d55bd2fbeb28a42f7c3638b8c |
Hashes for mkdocs_caseinsensitive_plugin-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 218c4aacf75a57243d60cbe774fafbc31f9042a3597072d1fa4f73991d9e5008 |
|
MD5 | cc9e7ab7ba1fd53e29478e6d6f51b474 |
|
BLAKE2b-256 | 0adfeaacfca1619713ca3bf06b5271a375943acb47659879d499226900420b15 |