https://github.com/sondregronas/mkdocs-submodule-edit-uri

A super simple plugin to convert the edit_uri for GitHub submodules
https://github.com/sondregronas/mkdocs-submodule-edit-uri

Last synced: 7 months ago
JSON representation

A super simple plugin to convert the edit_uri for GitHub submodules

• Host: GitHub
• URL: https://github.com/sondregronas/mkdocs-submodule-edit-uri
• Owner: sondregronas
• License: mit
• Created: 2022-08-16T14:15:30.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-23T14:58:20.000Z (over 1 year ago)
• Last Synced: 2024-05-01T18:54:55.170Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 39.1 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# mkdocs-submodule-edit-uri

[![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/)

[![GitHub latest commit](https://img.shields.io/github/last-commit/sondregronas/mkdocs-submodule-edit-uri)](https://github.com/sondregronas/mkdocs-submodule-edit-uri/commit/)

[![PyPi](https://img.shields.io/pypi/v/mkdocs-submodule-edit-uri)](https://pypi.org/project/mkdocs-submodule-edit-uri/)

![MIT license](https://img.shields.io/github/license/sondregronas/mkdocs-submodule-edit-uri)

[![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)

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

```yaml

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.