Tweak nav

Author: barryvdh

docs/features.md

@@ -1,3 +1,7 @@
+---
+hide:
+  - navigation
+---
 !!! warning
 
     Debugbar can slow the application down (because it has to gather and render data). So when experiencing slowness, try disabling some of the collectors.

docs/index.md

@@ -3,5 +3,5 @@ template: home.html
 title: Laravel Debugbar
 hide:
   - navigation
-  - toc
+  - toc 
 ---

docs/install.md renamed to docs/installation.md

@@ -17,7 +17,7 @@ The Debugbar will be enabled when `APP_DEBUG` is `true`.
 
 > If you use a catch-all/fallback route, make sure you load the Debugbar ServiceProvider before your own App ServiceProviders.
 
-### Laravel without auto-discovery:
+### Without auto-discovery
 
 If you don't use auto-discovery, add the ServiceProvider to the providers list. For Laravel 11 or newer, add the ServiceProvider in bootstrap/providers.php. For Laravel 10 or older, add the ServiceProvider in config/app.php.
 
@@ -39,13 +39,13 @@ The profiler is enabled by default, if you have APP_DEBUG=true. You can override
 You can also set in your config if you want to include/exclude the vendor files also (FontAwesome, Highlight.js and jQuery). If you already use them in your site, set it to false.
 You can also only display the js or css vendors, by setting it to 'js' or 'css'. (Highlight.js requires both css + js, so set to `true` for syntax highlighting)
 
-#### Copy the package config to your local config with the publish command:
+### Publish config
 
 ```shell
 php artisan vendor:publish --provider="Barryvdh\Debugbar\ServiceProvider"
 ```
 
-### Laravel with Octane:
+### With Octane
 
 Make sure to add LaravelDebugbar to your flush list in `config/octane.php`.
 
@@ -55,7 +55,7 @@ Make sure to add LaravelDebugbar to your flush list in `config/octane.php`.
     ],
 ```
 
-### Lumen:
+### With Lumen
 
 For Lumen, register a different Provider in `bootstrap/app.php`:
 

mkdocs.yml

@@ -1,12 +1,18 @@
 site_name: Laravel Debugbar
+site_author: Barry vd. Heuvel
 site_description: Debugbar for Laravel
 site_url: https://laraveldebugbar.com
 repo_url: https://github.com/barryvdh/laravel-debugbar
+edit_uri: ./edit/docs/docs
+copyright: Copyright © Barry vd. Heuvel
+
 nav:
   - Home: index.md
-  - Install: install.md
+  - Getting started:
+      - Install: installation.md
+      - Usage: usage.md
   - Features: features.md
-  - Usage: usage.md
+
 theme:
   name: material
   custom_dir: overrides
@@ -26,6 +32,9 @@ theme:
     - navigation.sections
     - navigation.expand
     - content.code.copy
+    - content.action.edit
+    - toc.follow
+    - search.highlight
 extra_css:
   - assets/extra.css
   - assets/debugbar.css
@@ -45,4 +54,11 @@ markdown_extensions:
             startinline: true
   - pymdownx.inlinehilite
   - pymdownx.snippets
-  - pymdownx.superfences
+  - pymdownx.superfences
+  - toc:
+      permalink: true
+  - pymdownx.magiclink:
+      normalize_issue_symbols: true
+      repo_url_shorthand: true
+      user: barryvdh
+      repo: laravel-debugbar

overrides/home.html

@@ -12,7 +12,9 @@
 .md-content h1, .home-content h1 {
     display: none
 }
-
+.md-content__button {
+    display: none;
+}
 @media screen and (min-width: 60em) {
     .md-sidebar--secondary {
         display: none
@@ -45,10 +47,9 @@ <h1>{{ config.site_description }}</h1>
             </div>
             <div class="mdx-hero__content">
 
-                <p>Get started in 1 minute.</p>
                 <a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | e }}"
                    class="md-button md-button--primary">
-                    Install
+                    Get started
                 </a>
                 <a href="{{ config.repo_url }}" title="View on Github" class="md-button">
                     View on Github