| Name | mkdocs-same-dir JSON |
| Version |
0.1.3
JSON |
| download |
| home_page | |
| Summary | MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation |
| upload_time | 2024-01-31 23:08:12 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | |
| keywords |
mkdocs
mkdocs-plugin
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# mkdocs-same-dir
**[Plugin][] for [MkDocs][] to allow placing *mkdocs.yml* in the same directory as documentation**
[](https://pypi.org/project/mkdocs-same-dir/)
[](https://github.com/oprypin/mkdocs-same-dir/blob/master/LICENSE.md)
[](https://github.com/oprypin/mkdocs-same-dir/actions?query=event%3Apush+branch%3Amaster)
```shell
pip install mkdocs-same-dir
```
[mkdocs]: https://www.mkdocs.org/
[plugin]: https://www.mkdocs.org/user-guide/plugins/
## Usage
Activate the plugin in **mkdocs.yml**, along with actually changing `docs_dir`
(normally, MkDocs *absolutely wouldn't* let you set it to `.`):
```yaml
site_name: foo
docs_dir: .
site_dir: ../site
plugins:
- search
- same-dir
```
and now you can move this **mkdocs.yml** into your **docs** directory, or move your docs alongside **mkdocs.yml**.
[**See example layout**](https://github.com/oprypin/mkdocs-same-dir/tree/master/example)
### Important notes
Another necessary effect of this plugin is that files *directly at the root* of the **docs** dir will no longer be picked up, unless they are Markdown files.
And note that the [implementation](https://github.com/oprypin/mkdocs-same-dir/blob/master/mkdocs_same_dir/plugin.py) of this plugin is a huge hack that monkeypatches MkDocs' internals. But I pledge to keep up with MkDocs updates and keep it working as long as that's still possible.
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-same-dir",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "mkdocs,mkdocs-plugin",
"author": "",
"author_email": "Oleh Prypin <oleh@pryp.in>",
"download_url": "https://files.pythonhosted.org/packages/fc/a7/6a82cc2d73339f46ec4752e60b8bd5e412f104a2da9c8ad60c537c0e2cf5/mkdocs_same_dir-0.1.3.tar.gz",
"platform": null,
"description": "# mkdocs-same-dir\n\n**[Plugin][] for [MkDocs][] to allow placing *mkdocs.yml* in the same directory as documentation**\n\n[](https://pypi.org/project/mkdocs-same-dir/)\n[](https://github.com/oprypin/mkdocs-same-dir/blob/master/LICENSE.md)\n[](https://github.com/oprypin/mkdocs-same-dir/actions?query=event%3Apush+branch%3Amaster)\n\n```shell\npip install mkdocs-same-dir\n```\n\n[mkdocs]: https://www.mkdocs.org/\n[plugin]: https://www.mkdocs.org/user-guide/plugins/\n\n## Usage\n\nActivate the plugin in **mkdocs.yml**, along with actually changing `docs_dir` \n(normally, MkDocs *absolutely wouldn't* let you set it to `.`):\n\n```yaml\nsite_name: foo\ndocs_dir: .\nsite_dir: ../site\n\nplugins:\n - search\n - same-dir\n```\n\nand now you can move this **mkdocs.yml** into your **docs** directory, or move your docs alongside **mkdocs.yml**.\n\n[**See example layout**](https://github.com/oprypin/mkdocs-same-dir/tree/master/example)\n\n### Important notes\n\nAnother necessary effect of this plugin is that files *directly at the root* of the **docs** dir will no longer be picked up, unless they are Markdown files.\n\nAnd note that the [implementation](https://github.com/oprypin/mkdocs-same-dir/blob/master/mkdocs_same_dir/plugin.py) of this plugin is a huge hack that monkeypatches MkDocs' internals. But I pledge to keep up with MkDocs updates and keep it working as long as that's still possible.\n",
"bugtrack_url": null,
"license": "",
"summary": "MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation",
"version": "0.1.3",
"project_urls": {
"Documentation": "https://oprypin.github.io/mkdocs-same-dir/",
"Issues": "https://github.com/oprypin/mkdocs-same-dir/issues",
"Source": "https://github.com/oprypin/mkdocs-same-dir"
},
"split_keywords": [
"mkdocs",
"mkdocs-plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e3e8fe1e052756db178aec15cbcc30d60b5e10bf131078c9f785498379743e9",
"md5": "26be89277595de859c01172da7a2ff0d",
"sha256": "3d094649e2e47efcf90a8b0051a4c2b837aaf4137a28c8e334ba9465804a317e"
},
"downloads": -1,
"filename": "mkdocs_same_dir-0.1.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "26be89277595de859c01172da7a2ff0d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4238,
"upload_time": "2024-01-31T23:08:10",
"upload_time_iso_8601": "2024-01-31T23:08:10.563548Z",
"url": "https://files.pythonhosted.org/packages/2e/3e/8fe1e052756db178aec15cbcc30d60b5e10bf131078c9f785498379743e9/mkdocs_same_dir-0.1.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fca76a82cc2d73339f46ec4752e60b8bd5e412f104a2da9c8ad60c537c0e2cf5",
"md5": "c2d1914505807d472758a3fdda1afdb3",
"sha256": "c849556b1d79ae270947f41bb89d442aa1e858ab6ec6423eb178ae76a7f984fc"
},
"downloads": -1,
"filename": "mkdocs_same_dir-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "c2d1914505807d472758a3fdda1afdb3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4133,
"upload_time": "2024-01-31T23:08:12",
"upload_time_iso_8601": "2024-01-31T23:08:12.107657Z",
"url": "https://files.pythonhosted.org/packages/fc/a7/6a82cc2d73339f46ec4752e60b8bd5e412f104a2da9c8ad60c537c0e2cf5/mkdocs_same_dir-0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 23:08:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "oprypin",
"github_project": "mkdocs-same-dir",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-same-dir"
}
