Allow using pretty URLs #485
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
ok good idea, but it may be too late to make rc2. will have to see about final. |
In preparation of pretty URLs, make file extension mangling a responsibility of the particular Writer module. Before the writing step, all links should point to the original files, which generally have the .md extension. This only affects LatexWriter, since HTMLWriter already fixes .md links and for the :markdown format nothing is actually done to the links in the cross-referencing phase.
|
I should take another look at the code after a good night's sleep, but I believe it's done, and I don't think I have broken any old features even though I had to refactor a bit.
|
If :html_prettyurls is enabled then every page gets written into an index.html file under a separate directory. This yields cleaner URLs when the page is hosted as a website (e.g. under gh-pages). Specifically, a file `dir/file.md` can then be accessed via `dir/file/` instead of `dir/file.html`.
22 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Allows pretty URLs to be used in the HTML build, i.e.
dir/page.mdcan be referenced asdir/page/instead of the currentdir/page.html. This behaviour is consistent with MkDocs and Sphinx, and has been on the roadmap.This is done by storing the actual page in
dir/page/index.html. It does mean that this can't be used for local / offline builds though.Currently it has to enabled via the
html_prettyurlsoption and is disabled by default. It should become the default for the deploy-to-gh-pages builds for packages, even though it will involve breaking existing links.@tkelman I think this would also be nice to have for 0.6. This way we won't have to swap to
.htmllinks for a release and then back again (assuming we want this in the long term), potentially breaking quite a lot of references to Base docs. Also, links that were referring to the 0.5 docs should start working again. For Base we should enable this feature explicitly and only for thegh-pagesbuilds.WIP because some internal links are still not being generated correctly, code needs cleanup and more testing.
Example build: http://mortenpi.eu/Documenter.jl/pretty-urls-deploy/