Add a url filter to templates. #1526
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
Currently all local URLs must be prepended with base_url while external links must not. However, we can have both types of links in the same collection. As prepreprocessing of extra_css and extra_javascript settings is deprecated, we need a way to indicate the URL should be prepended, but only if it needs to be. The same applies to external links included in the site navigation. Therefore, a new temaplte filter is provided which any URL can be passed to. If the URL is absolute, it is returned unaltered. If it is relative and the template context includes a `page` object, then a URL is returned reltive to the page object. Otherwise, the URL is returned with base_url prepended. This also results in cleaner output as paths are normailized (redundant . are removed). Of course, the base_url tempalte variable remains (it is not being deprecated -- in fact the new filter relies on its existance) and template authors may continue to use it if they desire.
|
Sigh. The tests are failing due to a new rule in Markdownlint 0.5.0. But that will be handled separately from this PR (see #1530). |
Merged
waylan
added a commit
that referenced
this pull request
Jul 3, 2018
The Python-Markdown parser includes support for fenced code blocks, but only at the root level of the document. Therefore, a code block nested in a list item must be an indented block. At the same time, MkDocs' code highlighting relies on the language identifier in fenced code blocks to avoid bad guesses. Given the above, we want to allow mixing both styles of code blocks and the way to allow that is to disable Markdown Lint [rule MD046](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md046---code-block-style). This new rule was introduced in Markdownlint version [0.5.0](https://github.com/markdownlint/markdownlint/blob/master/CHANGELOG.md#v050) and is currently causing the [tests to fail](https://travis-ci.org/mkdocs/mkdocs/jobs/399711017). This was first discovered in #1526.
waylan
added a commit
that referenced
this pull request
Jul 3, 2018
The Python-Markdown parser includes support for fenced code blocks, but only at the root level of the document. Therefore, a code block nested in a list item must be an indented block. At the same time, MkDocs' code highlighting relies on the language identifier in fenced code blocks to avoid bad guesses. Given the above, we want to allow mixing both styles of code blocks and the way to allow that is to disable Markdown Lint [rule MD046](https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md046---code-block-style). This new rule was introduced in Markdownlint version [0.5.0](https://github.com/markdownlint/markdownlint/blob/master/CHANGELOG.md#v050) and is currently causing the [tests to fail](https://travis-ci.org/mkdocs/mkdocs/jobs/399711017). This was first discovered in #1526.
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.
Currently all local URLs must be prepended with
base_urlwhile externallinks must not. However, we can have both types of links in the same
collection. As prepreprocessing of extra_css and extra_javascript
settings is deprecated, we need a way to indicate the URL should be
prepended, but only if it needs to be. The same applies to external
links included in the site navigation.
Therefore, a new temaplte filter is provided which any URL can be passed
to. If the URL is absolute, it is returned unaltered. If it is relative
and the template context includes a
pageobject, then a URL isreturned reltive to the page object. Otherwise, the URL is returned with
base_urlprepended. This also results in cleaner output as paths arenormailized (redundant
.are removed). Of course, thebase_urltemplatevariable remains (it is not being deprecated -- in fact the new filter
relies on its existance) and template authors may continue to use it if
they desire.
Docs still need updated and we may need a few tests.