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

GitHub repo link appears, but no "Edit on GitHub" link appears #1129

Closed
chrisdeeming opened this Issue Jan 23, 2017 · 2 comments

Comments

Projects
None yet
2 participants
@chrisdeeming

chrisdeeming commented Jan 23, 2017

Hello,

Although a number of these options appear to have suitable defaults, I have the following in my mkdocs.yml file:

repo_name: GitHub
repo_url: https://github.com/chrisdeeming/reponame/
edit_uri: edit/master/docs/

I have only just recently updated to mkdocs, version 0.16.1 and unfortunately no edit link appears (using the default, unmodified theme).

Assuming it should appear in the breadcrumb area, all I see is this:

image

The "GitHub" link just links to https://github.com/chrisdeeming/reponame/ as per the repo_url. Does displaying the edit link require some sort of manual action on each page?

Many thanks,

Chris

@waylan

This comment has been minimized.

Member

waylan commented Jan 23, 2017

See this comment for an explanation of the current situation. It appears that the plan was to leave the current link as-is and add a new second ("edit this page") link to the mkdocs theme (the readthedocs theme already had two separate links). But the issue got closed when the edit feature was added and then it was forgotten about. Thanks for the reminder. We can use this issue to track this much narrower feature now.

@waylan waylan added the Enhancement label Jan 23, 2017

@waylan waylan added this to the 1.0.0 milestone Jan 23, 2017

@chrisdeeming

This comment has been minimized.

chrisdeeming commented Feb 6, 2017

Also, just an aesthetic thing, there should probably be a space after the icon and GitHub.

jkinkead added a commit to jkinkead/mkdocs that referenced this issue Oct 10, 2017

waylan added a commit to waylan/mkdocs that referenced this issue Oct 19, 2017

Add "edit link" support to MkDocs theme.
Theme shows either a repo link or an edit link depending on whether
`edit_uri` is set. Also clarified documentation that this behavior is
dependant upon theme support. Fixes mkdocs#1129.

@waylan waylan closed this in #1313 Oct 19, 2017

waylan added a commit that referenced this issue Oct 19, 2017

Add "edit link" support to MkDocs theme.
Theme shows either a repo link or an edit link depending on whether
`edit_uri` is set. Also clarified documentation that this behavior is
dependant upon theme support. Fixes #1129.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment