Fix docs for #741

thephpleague · Nov 8, 2021 · 8005bfc · 8005bfc
1 parent d736d39
commit 8005bfc
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ Updates should follow the [Keep a CHANGELOG](https://keepachangelog.com/) princi
 ### Added
 
 - Added support for ext-yaml in FrontMatterExtension (#715)
+- Added new `heading_permalink/aria_hidden` config option (#741)
 
 ## [2.0.2] - 2021-08-14
 

diff --git a/docs/2.0/extensions/heading-permalinks.md b/docs/2.0/extensions/heading-permalinks.md
@@ -44,7 +44,6 @@ $config = [
         'max_heading_level' => 6,
         'title' => 'Permalink',
         'symbol' => HeadingPermalinkRenderer::DEFAULT_SYMBOL,
-        'aria_hidden' => true
     ],
 ];
 
@@ -112,12 +111,6 @@ If you want to use a custom icon, then set this to an empty string `''` and chec
 
 This option sets the `title` attribute on the `<a>` tag.  This defaults to `'Permalink'`.
 
-### `aria_hidden`
-
-This option sets the `aria-hidden` attribute on the `<a>` tag. This defaults to `aria-hidden="true"`.
-
-Setting this option to false would render the `<a>` tag excluding the `aria-hidden` entirely.
-
 ## Example
 
 If you wanted to style your headings exactly like this documentation page does, try this configuration!

diff --git a/docs/2.1/extensions/heading-permalinks.md b/docs/2.1/extensions/heading-permalinks.md
@@ -44,7 +44,7 @@ $config = [
         'max_heading_level' => 6,
         'title' => 'Permalink',
         'symbol' => HeadingPermalinkRenderer::DEFAULT_SYMBOL,
-        'aria_hidden' => true
+        'aria_hidden' => true,
     ],
 ];