-
Notifications
You must be signed in to change notification settings - Fork 481
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
Link to repo in navbar #1254
Link to repo in navbar #1254
Conversation
There is animo for this! Anything we can do to help? |
It seems like this change has not been included in the latest release, although it was included in the changelog for v0.27.22? https://github.com/JuliaDocs/Documenter.jl/blob/v0.27.23/src/Writers/HTMLWriter.jl |
It is under the 0.28 release, no? |
Out of curiosity (since I've been watching this PR as well): Is there a (tentative) ETA on v0.28? |
That's my bad -- it did end up in the auto-generated changelog of the GitHub release. The only changelog that matters is what is in As for 0.28: I wouldn't want to put a date to it. There are a couple of fixes that should go in first that I haven't had the chance to tackle yet. However, you can always add a Manifest and use the |
Adds a way to link to the root of the repository in the navbar. The prominence of the edit link is reduced by having it just as an icon:
By default, HTMLWriter will try to figure this out based on the remote repository, which can be configured using the
repo
argument ofmakedocs
:Remotes
module, which contains types to configure the remote explicitly, e.g.:makedocs(repo = Remotes.GitHub("JuliaDocs", "Documenter.jl")
repo
keyword is not passed, Documenter tries to determine it by looking at theorigin
remote of the source (as before).The
HTML
format type now also takes therepolink
keyword which can be used to either override the repository URL determined fromrepo
(by passing aString
), or hide the repository link (by passingnothing
).Close #1377