mkdocs-submodule-edit-uri 1.1.0

A plugin to convert the edit_uri for GitHub submodules

mkdocs-submodule-edit-uri

A super simple plugin to convert the edit_uri to match in GitHub submodules, allowing you to store parts of your docs on different repositories

Install using pip install mkdocs-submodule-edit-uri

Replaces a given old string to a new string wherever possible on mkdocs page content.

Usage

repo_url: https://github.com/user/repo
edit_uri: edit/main/docs/

plugins:
  - search
  - submodule-edit-uri:
      modules:
      - sub1:
          old: https://github.com/user/repo/edit/main/docs/SUBMODULE
          new: https://github.com/user/repo-SUBMODULE/edit/main
      - sub1-view:
          old: https://github.com/user/repo/raw/main/docs/SUBMODULE
          new: https://github.com/user/repo-SUBMODULE/raw/main
      - sub2-namedoesntmatter:
          old: https://github.com/user/repo/edit/main/docs/SUBMODULE2
          new: https://github.com/user/repo-SUBMODULE2/edit/main
      - sub2-namedoesntmatter-view:
          old: https://github.com/user/repo/raw/main/docs/SUBMODULE2
          new: https://github.com/user/repo-SUBMODULE2/raw/main

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.

Note: please have the old variable be as specific as possible, as to not accidentally replace any other strings that might match the old value.