{"id":15057045,"url":"https://github.com/sondregronas/mkdocs-submodule-edit-uri","last_synced_at":"2026-01-04T09:05:03.985Z","repository":{"id":140173976,"uuid":"525410442","full_name":"sondregronas/mkdocs-submodule-edit-uri","owner":"sondregronas","description":"A super simple plugin to convert the edit_uri for GitHub submodules","archived":false,"fork":false,"pushed_at":"2023-10-23T14:58:20.000Z","size":40,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-03T08:52:28.474Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/sondregronas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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":"sondregronas"}},"created_at":"2022-08-16T14:15:30.000Z","updated_at":"2022-08-27T03:57:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"c6fbc929-07fd-4e3d-a2ed-165db4cd0181","html_url":"https://github.com/sondregronas/mkdocs-submodule-edit-uri","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/sondregronas/mkdocs-submodule-edit-uri","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sondregronas%2Fmkdocs-submodule-edit-uri","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sondregronas%2Fmkdocs-submodule-edit-uri/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sondregronas%2Fmkdocs-submodule-edit-uri/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sondregronas%2Fmkdocs-submodule-edit-uri/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sondregronas","download_url":"https://codeload.github.com/sondregronas/mkdocs-submodule-edit-uri/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sondregronas%2Fmkdocs-submodule-edit-uri/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263549597,"owners_count":23478836,"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":[],"created_at":"2024-09-24T22:01:15.636Z","updated_at":"2026-01-04T09:05:03.941Z","avatar_url":"https://github.com/sondregronas.png","language":"Python","funding_links":["https://github.com/sponsors/sondregronas"],"categories":[],"sub_categories":[],"readme":"# mkdocs-submodule-edit-uri\n[![Build Status](https://img.shields.io/github/actions/workflow/status/sondregronas/mkdocs-submodule-edit-uri/CI.yml?branch=main)](https://github.com/sondregronas/mkdocs-submodule-edit-uri/)\n[![GitHub latest commit](https://img.shields.io/github/last-commit/sondregronas/mkdocs-submodule-edit-uri)](https://github.com/sondregronas/mkdocs-submodule-edit-uri/commit/)\n[![PyPi](https://img.shields.io/pypi/v/mkdocs-submodule-edit-uri)](https://pypi.org/project/mkdocs-submodule-edit-uri/)\n![MIT license](https://img.shields.io/github/license/sondregronas/mkdocs-submodule-edit-uri)\n[![codecov](https://codecov.io/gh/sondregronas/mkdocs-submodule-edit-uri/branch/main/graph/badge.svg?token=N5IDI7Q4NZ)](https://codecov.io/gh/sondregronas/mkdocs-submodule-edit-uri)\n\nA super simple plugin to convert the edit_uri to match in GitHub submodules, allowing you to store parts of your docs on different repositories\n\nInstall using `pip install mkdocs-submodule-edit-uri`\n\nReplaces a given `old` string to a `new` string wherever possible on mkdocs page content.\n\n## Usage\n```yaml\nrepo_url: https://github.com/user/repo\nedit_uri: edit/main/docs/\n\nplugins:\n  - search\n  - submodule-edit-uri:\n      modules:\n      - sub1:\n          old: https://github.com/user/repo/edit/main/docs/SUBMODULE\n          new: https://github.com/user/repo-SUBMODULE/edit/main\n      - sub1-view:\n          old: https://github.com/user/repo/raw/main/docs/SUBMODULE\n          new: https://github.com/user/repo-SUBMODULE/raw/main\n      - sub2-namedoesntmatter:\n          old: https://github.com/user/repo/edit/main/docs/SUBMODULE2\n          new: https://github.com/user/repo-SUBMODULE2/edit/main\n      - sub2-namedoesntmatter-view:\n          old: https://github.com/user/repo/raw/main/docs/SUBMODULE2\n          new: https://github.com/user/repo-SUBMODULE2/raw/main\n```\n\u003e **Note:** If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly.\n\nNote: please have the `old` variable be as specific as possible, as to not accidentally replace any other strings that might match the `old` value.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsondregronas%2Fmkdocs-submodule-edit-uri","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsondregronas%2Fmkdocs-submodule-edit-uri","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsondregronas%2Fmkdocs-submodule-edit-uri/lists"}