Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add possibility to overwrite repo_url and edit_uri for includes #2

Closed
ghost opened this issue Oct 10, 2019 · 5 comments
Closed

Add possibility to overwrite repo_url and edit_uri for includes #2

ghost opened this issue Oct 10, 2019 · 5 comments

Comments

@ghost
Copy link

ghost commented Oct 10, 2019

Thanks for this plugin, it's great.

We like to use the edit button to jump directly to our git repo in edit mode.

However when using !include the path doesn't match any longer the one which is specified in edit_uri in the main mkdocs.yml.

It would be great to have the possibility to add repo_url and edit_uri for the included dirs so that the correct git repo and edit_uri links are generated.

@ghost
Copy link
Author

ghost commented Oct 10, 2019

I didn't check the plugins wiki and noticed there is already a plugin which does exactly that.

https://gitlab.com/paulrbr/mkdocs-edit-url

@ghost ghost closed this as completed Oct 10, 2019
@bih
Copy link
Collaborator

bih commented Oct 11, 2019

@claaslisowski Ah interesting, yes this is something we haven't easily figured out yet. We will take a look at that plugin and see if we can incorporate that functionality directly (given it's a small plugin)

@FredrikMeyer
Copy link

Is there any update on this? (or was it somehow possible to use the plugin mentioned above?) Thanks.

@marc0olo
Copy link

why is that issue closed? I am currently playing around with this plugin where I want to aggregate MkDocs of multiple repositories using submodule includes.

it's crucial for me to have the correct edit link for the respective submodule repo.

did anyone solve that problem?

does https://gitlab.com/paulrbr/mkdocs-edit-url really help with that or am I talking about another issue?

@jdoiro3
Copy link

jdoiro3 commented Dec 24, 2021

I'm working on a slightly different plugin. In mkdocs-multirepo-plugin, you can specify the edit_uri in the config for each repo or in repo's mkdocs.yml. The implementation is in the on_NAV event.

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants