Remove the enabled key from the permalinks configuration

hydephp · Dec 3, 2024 · f53eb4d · f53eb4d
1 parent 4e80297
commit f53eb4d
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 6 deletions.
diff --git a/config/markdown.php b/config/markdown.php
@@ -108,7 +108,6 @@
     */
 
     'permalinks' => [
-        'enabled' => true,
         'pages' => [
             \Hyde\Pages\DocumentationPage::class,
         ],

diff --git a/docs/digging-deeper/advanced-markdown.md b/docs/digging-deeper/advanced-markdown.md
@@ -169,13 +169,11 @@ Hyde automatically adds clickable permalink anchors to headings in documentation
 
 The feature is enabled by default for documentation pages. When enabled, Hyde will automatically add permalink anchors to headings between levels 2-4 (h2-h4). The permalinks are hidden by default and appear when hovering over the heading.
 
-
-You can disable the feature, or enable it for other page types, in the `config/markdown.php` file.
+You can enable it for other page types by adding the page class to the `permalinks.pages` array in the `config/markdown.php` file, or disable it for all pages by setting the array to an empty array.
 
 ```php
 // filepath: config/markdown.php
 'permalinks' => [
-    'enabled' => true,
     'pages' => [
         \Hyde\Pages\DocumentationPage::class,
     ],

diff --git a/packages/framework/config/markdown.php b/packages/framework/config/markdown.php
@@ -108,7 +108,6 @@
     */
 
     'permalinks' => [
-        'enabled' => true,
         'pages' => [
             \Hyde\Pages\DocumentationPage::class,
         ],

diff --git a/packages/framework/tests/Feature/MarkdownHeadingRendererTest.php b/packages/framework/tests/Feature/MarkdownHeadingRendererTest.php
@@ -164,7 +164,7 @@ public function testPermalinkConfigurationLevels()
 
     public function testDisablingPermalinksGlobally()
     {
-        config(['markdown.permalinks.enabled' => false]);
+        config(['markdown.permalinks.pages' => []]);
 
         $markdown = '## Heading';
         $html = (new MarkdownService($markdown, DocumentationPage::class))->parse();