{"id":13573510,"url":"https://github.com/oprypin/mkdocs-same-dir","last_synced_at":"2025-04-10T10:08:36.179Z","repository":{"id":47178172,"uuid":"259093670","full_name":"oprypin/mkdocs-same-dir","owner":"oprypin","description":"MkDocs plugin to allow placing mkdocs.yml in the same directory as documentation","archived":false,"fork":false,"pushed_at":"2025-02-15T16:34:10.000Z","size":63,"stargazers_count":44,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T09:02:44.367Z","etag":null,"topics":["mkdocs","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://oprypin.github.io/mkdocs-same-dir","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oprypin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"oprypin"}},"created_at":"2020-04-26T17:38:21.000Z","updated_at":"2025-03-10T17:50:08.000Z","dependencies_parsed_at":"2023-02-16T00:45:20.577Z","dependency_job_id":"c5cbc077-e406-4f04-b530-a445c38a9241","html_url":"https://github.com/oprypin/mkdocs-same-dir","commit_stats":{"total_commits":29,"total_committers":2,"mean_commits":14.5,"dds":0.03448275862068961,"last_synced_commit":"3fb1b0ca652c5ed9d2abc554790d1ceee567d191"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-same-dir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-same-dir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-same-dir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oprypin%2Fmkdocs-same-dir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oprypin","download_url":"https://codeload.github.com/oprypin/mkdocs-same-dir/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198884,"owners_count":21063628,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-plugin"],"created_at":"2024-08-01T15:00:37.047Z","updated_at":"2025-04-10T10:08:36.140Z","avatar_url":"https://github.com/oprypin.png","language":"Python","funding_links":["https://github.com/sponsors/oprypin"],"categories":["Python"],"sub_categories":[],"readme":"# mkdocs-same-dir\n\n**[Plugin][] for [MkDocs][] to allow placing *mkdocs.yml* in the same directory as documentation**\n\n[![PyPI](https://img.shields.io/pypi/v/mkdocs-same-dir)](https://pypi.org/project/mkdocs-same-dir/)\n[![License](https://img.shields.io/github/license/oprypin/mkdocs-same-dir)](https://github.com/oprypin/mkdocs-same-dir/blob/master/LICENSE.md)\n[![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)\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foprypin%2Fmkdocs-same-dir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foprypin%2Fmkdocs-same-dir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foprypin%2Fmkdocs-same-dir/lists"}