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 a url filter to templates. #1526

Merged
merged 2 commits into from Jul 3, 2018

Conversation

Projects
None yet
1 participant
@waylan
Member

waylan commented Jul 2, 2018

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 template
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.

Docs still need updated and we may need a few tests.

Add a url filter to templates.
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.
@waylan

This comment has been minimized.

Member

waylan commented Jul 3, 2018

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).

@waylan waylan added this to the 1.0.0 milestone Jul 3, 2018

@waylan waylan referenced this pull request Jul 3, 2018

Merged

Pages Refactor #1504

waylan added a commit that referenced this pull request Jul 3, 2018

Exclude code block style from Markdownlint
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

Exclude code block style from Markdownlint
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 waylan merged commit a1b26eb into mkdocs:master Jul 3, 2018

1 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details

@waylan waylan deleted the waylan:url-filter branch Jul 3, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment