-
Notifications
You must be signed in to change notification settings - Fork 480
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 "Powered by ..." message to footer #1365
Conversation
I think it looks nice. Adding "Julia" to the page also makes it more likely to be found when googling something related to the package + "julia". Right now, there are many documentation pages without the term "julia" at all which might lead to worse discoverability. |
Literate.jl also adds this to the footer, so an opt-out mechanism would be a must from my perspective. See the With an opt-out mechanism, users could manually customize credit to two or more packages in one line. |
I think we should have this as the default message but easy to change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for tackling this @pfitzseb!
-
As we said in A customizable footer on generated pages #1184, with this phrasing, I think it makes sense to have it be opt-out. I see it as a way to subtly advertise Documenter & Julia to the readers, with any SEO benefits being incidental. I do think there should be an option to opt-out. A
footer
keyword toHTML
? -
I think ideally we'd also allow the users to override the content. Probably formatted as an (inline) Markdown string, so that e.g. links would also work?
-
Finally, maybe it would be also good to allow it to be overridden on a per-page basis in an at-meta block? This would allow tools like Literate to put their "Powered by" messages into the footers (cc @fredrikekre).
The latter two could definitely be done later as follow-ups.
Co-authored-by: Morten Piibeleht <morten.piibeleht@gmail.com>
Co-authored-by: Morten Piibeleht <morten.piibeleht@gmail.com>
Alright, added a The argument checking for |
What might work is to see if it parses to a single |
Done :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I took the liberty of adding the CHANGELOG and try it out in test/examples. I think only thing left is adding docs about the footer
keyword into the docstring of HTML
?
Co-authored-by: Morten Piibeleht <morten.piibeleht@gmail.com>
Co-authored-by: Morten Piibeleht <morten.piibeleht@gmail.com>
Co-authored-by: Morten Piibeleht <morten.piibeleht@gmail.com>
Alright, pushed an update to the docs. |
Customized footer affects globally. Using this with Literate.jl would either 1) inserting two credit footers for Literate-generated pages, or 2) add credit for Literate even in other pages that are not Literate-generated. |
LGTM, thanks again @pfitzseb!
Yeah, it might be nice to be able to override it also on a per-page basis: #1370. |
This should help a bit with SEO and therefore Julia's ranking (both for Julia itself and packages). AFAIU it's not ideal to put this in the footer, but I don't know enough about how Google ranks websites to figure out something better.
Open questions:
cc @ViralBShah
Edit by @mortenpi: fixes #1184