feat: add option to disable breadrumbs, add missing URLs in breadcrumbs

Signed-off-by: Lukas Frey <mail@lukasfrey.cz>

README.md

@@ -433,7 +433,20 @@ $plugin->slideOverPreviews();
 
 ![Modal Slideover Example](/docs/images/screenshot_modal_slideovers.jpeg)
 
-### Enable breadcrumbs in modal preview titles
+### Breadcrubs
+#### Disable breadcrumbs
+
+By default on each documentation page, there is a breadcrumb at the top. You can disable it if you wish:
+
+```php
+use Guava\FilamentKnowledgeBase\Filament\Panels\KnowledgeBasePanel;
+
+KnowledgeBasePanel::configureUsing(
+    fn(KnowledgeBasePanel $panel) => $panel
+        ->disableBreadcrumbs()
+);
+```
+#### Enable breadcrumbs in modal preview titles
 
 When using modal previews, by default the title shows just that, the title of the documentation page.
 

src/Concerns/CanDisableBreadcrumbs.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Guava\FilamentKnowledgeBase\Concerns;
+
+trait CanDisableBreadcrumbs
+{
+    protected bool $disableBreadcrumbs = false;
+
+    public function disableBreadcrumbs(bool $condition = true): static
+    {
+        $this->disableBreadcrumbs = $condition;
+
+        return $this;
+    }
+
+    public function shouldDisableBreadcrumbs(): bool
+    {
+        return $this->evaluate($this->disableBreadcrumbs);
+    }
+}

src/Filament/Pages/ViewDocumentation.php

@@ -28,6 +28,10 @@ public function getSubNavigationPosition(): SubNavigationPosition
 
     public function getBreadcrumbs(): array
     {
+        if (KnowledgeBase::panel()->shouldDisableBreadcrumbs()) {
+            return [];
+        }
+
         return $this->record->getBreadcrumbs();
     }
 

src/Filament/Panels/KnowledgeBasePanel.php

@@ -19,6 +19,7 @@
 use Filament\Widgets\AccountWidget;
 use Guava\FilamentKnowledgeBase\Concerns\CanDisableAnchors;
 use Guava\FilamentKnowledgeBase\Concerns\CanDisableBackToDefaultPanelButton;
+use Guava\FilamentKnowledgeBase\Concerns\CanDisableBreadcrumbs;
 use Guava\FilamentKnowledgeBase\Concerns\HasAnchorSymbol;
 use Guava\FilamentKnowledgeBase\Concerns\HasArticleClass;
 use Guava\FilamentKnowledgeBase\Contracts\Documentable;
@@ -42,6 +43,7 @@
 class KnowledgeBasePanel extends Panel
 {
     use CanDisableBackToDefaultPanelButton;
+    use CanDisableBreadcrumbs;
     use HasAnchorSymbol;
     use HasArticleClass;
 

src/Models/FlatfileDocumentation.php

@@ -2,6 +2,8 @@
 
 namespace Guava\FilamentKnowledgeBase\Models;
 
+use Arr;
+use Filament\Navigation\NavigationGroup;
 use Guava\FilamentKnowledgeBase\Contracts\Documentable;
 use Guava\FilamentKnowledgeBase\Facades\KnowledgeBase;
 use Guava\FilamentKnowledgeBase\Filament\Pages\ViewDocumentation;
@@ -15,7 +17,6 @@
 use League\CommonMark\Extension\FrontMatter\Output\RenderedContentWithFrontMatter;
 use League\CommonMark\Extension\HeadingPermalink\HeadingPermalink;
 use League\CommonMark\Output\RenderedContentInterface;
-use Spatie\StructureDiscoverer\Discover;
 use Sushi\Sushi;
 
 class FlatfileDocumentation extends Model implements Documentable
@@ -67,9 +68,6 @@ public function getRows()
             })
             ->toArray()
         ;
-        collect(Discover::in(app_path('KnowledgeBasePanel'))
-            ->extending(\Guava\FilamentKnowledgeBase\Pages\Documentation::class)
-            ->get());
     }
 
     public function getFrontMatter(): array
@@ -163,6 +161,16 @@ public function getParent(): ?string
         return $this->parent;
     }
 
+    public function getParentId(): ?string
+    {
+        $parts = str($this->getId())->explode('.', 3);
+        if (count($parts) >= 3) {
+            return $parts[0] . '.' . $parts[1];
+        }
+
+        return null;
+    }
+
     public function getGroup(): ?string
     {
         return $this->group;
@@ -186,20 +194,40 @@ public function isRegistered(): bool
     public function getBreadcrumbs(): array
     {
         return collect([
-            __('filament-knowledge-base::translations.knowledge-base'),
+            KnowledgeBase::panel()->getUrl() => __('filament-knowledge-base::translations.knowledge-base'),
         ])
             ->when(
                 $group = $this->getGroup(),
-                fn (Collection $collection) => $collection->push($group)
+                fn (Collection $collection) => $collection->put($this->getGroupUrl() . '#', $group)
             )
             ->when(
                 $parent = $this->getParent(),
-                fn (Collection $collection) => $collection->push($parent)
+                fn (Collection $collection) => $collection->put(
+                    ViewDocumentation::getUrl([
+                        'record' => KnowledgeBase::documentable($this->getParentId()),
+                    ], panel: config('filament-knowledge-base.panel.id', 'knowledge-base')),
+                    $parent,
+                )
             )
             ->put(ViewDocumentation::getUrl([
                 'record' => $this,
             ], panel: config('filament-knowledge-base.panel.id', 'knowledge-base')), $this->getTitle())
             ->toArray()
         ;
     }
+
+    public function getGroupUrl()
+    {
+        $group = collect(KnowledgeBase::panel()->getNavigation())
+            ->first(function ($item) {
+                return $item instanceof NavigationGroup && $item->getLabel() === $this->getGroup();
+            })
+        ;
+
+        if ($group) {
+            return Arr::first($group->getItems())->getUrl();
+        }
+
+        return null;
+    }
 }