https://github.com/oprypin/mkdocs-same-dir

MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation
https://github.com/oprypin/mkdocs-same-dir

mkdocs mkdocs-plugin

Last synced: 3 months ago
JSON representation

MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation

• Host: GitHub
• URL: https://github.com/oprypin/mkdocs-same-dir
• Owner: oprypin
• License: mit
• Created: 2020-04-26T17:38:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-11T18:54:41.000Z (11 months ago)
• Last Synced: 2024-09-30T08:01:24.512Z (4 months ago)
• Topics: mkdocs, mkdocs-plugin
• Language: Python
• Homepage: https://oprypin.github.io/mkdocs-same-dir
• Size: 54.7 KB
• Stars: 36
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• jimsghstars - oprypin/mkdocs-same-dir - MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation (Python)

README

        
# mkdocs-same-dir

**[Plugin][] for [MkDocs][] to allow placing *mkdocs.yml* in the same directory as documentation**

[![PyPI](https://img.shields.io/pypi/v/mkdocs-same-dir)](https://pypi.org/project/mkdocs-same-dir/)

[![License](https://img.shields.io/github/license/oprypin/mkdocs-same-dir)](https://github.com/oprypin/mkdocs-same-dir/blob/master/LICENSE.md)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/oprypin/mkdocs-same-dir/ci.yml.svg)](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.