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

HTMLWriter: add html_canonical option #622

Merged
merged 3 commits into from Jan 13, 2018

Conversation

Projects
None yet
2 participants
@tkluck
Copy link
Contributor

tkluck commented Jan 8, 2018

As discussed in #621, This allows search engines to point their users only to the most relevant version of a certain page. This is particularly useful when serving many similar pages (e.g. many versions of the same documentation).

See https://en.wikipedia.org/wiki/Canonical_link_element for details.

HTMLWriter: add html_canonical option
This allows search engines to point their users only to the most
relevant version of a certain page. This is particularly useful
when serving many similar pages (e.g. many versions of the same
documentation).

See https://en.wikipedia.org/wiki/Canonical_link_element for details.

tkluck added a commit to tkluck/PolynomialRings.jl that referenced this pull request Jan 8, 2018

docs: Add html_canonical option
This will give warnings until
JuliaDocs/Documenter.jl#622 is merged and
released.

@mortenpi mortenpi added this to the 0.13.0 milestone Jan 11, 2018

@mortenpi
Copy link
Member

mortenpi left a comment

Looks great! I think we could enable this right away for Documenter too, in docs/make.jl.

examples_html_doc = makedocs(
debug = true,
root = examples_root,
build = "builds/html-pretty-urls",

This comment has been minimized.

@mortenpi

mortenpi Jan 11, 2018

Member

The build should go into a separate directory. But I think it would actually be fine to just enable html_canonical for the normal "pretty URLs" build and not have a separate build. The html_canonical = nothing case will be tested by the other HTML build.

tkluck added some commits Jan 12, 2018

Remove superfluous parameter combinations in unit tests
It makes sense to have every parameter take on every value (e.g.
with and without `html_canonical`) but there's no need for a
combinatorial explosion of combinations of unrelated parameters.

Thanks to @mortenpi for suggesting this.
@tkluck

This comment has been minimized.

Copy link
Contributor Author

tkluck commented Jan 12, 2018

Thanks for the suggestions @mortenpi ! Just pushed new commits incorporating them.

@mortenpi mortenpi merged commit 40e12fa into JuliaDocs:master Jan 13, 2018

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment