From 17beafeca73788fb74afee5f56c91e0a3f02aee3 Mon Sep 17 00:00:00 2001 From: David Bruant Date: Fri, 26 Mar 2021 15:07:15 +0100 Subject: [PATCH] docs: Clarify relative_url and absolute_url filters (#8612) Co-authored-by: Michael Currin <18750745+MichaelCurrin@users.noreply.github.com> Co-authored-by: Frank Taillandier --- docs/_data/jekyll_filters.yml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/_data/jekyll_filters.yml b/docs/_data/jekyll_filters.yml index f4727ed3..de052a54 100644 --- a/docs/_data/jekyll_filters.yml +++ b/docs/_data/jekyll_filters.yml @@ -18,8 +18,8 @@ # - name: Relative URL description: >- - Prepend the baseurl value to the input. Useful if - your site is hosted at a subpath rather than the root of the domain. + Prepend baseurl config value to the input to convert a URL path into a relative URL. + This is recommended for a site that is hosted on a subpath of a domain. examples: - input: '{{ "/assets/style.css" | relative_url }}' output: '/my-baseurl/assets/style.css' @@ -27,7 +27,8 @@ # - name: Absolute URL - description: Prepend the url and baseurl value to the input. + description: >- + Prepend url and baseurl values to the input to convert a URL path to an absolute URL. examples: - input: '{{ "/assets/style.css" | absolute_url }}' output: 'http://example.com/my-baseurl/assets/style.css'