update docs

gwleuverink · Jan 11, 2024 · 45b3969 · 45b3969
1 parent 935232a
commit 45b3969
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,12 +1,20 @@
 title: Bundle
 description: Effortless page specific JavaScript modules in Laravel/Livewire apps
 remote_theme: just-the-docs/just-the-docs
+color_scheme: dark
 
 url: https://gwleuverink.github.io/bundle
 
 aux_links: # remove if you don't want this link to appear on your pages
   Github: https://github.com/gwleuverink/bundle
 
+enable_copy_code_button: true
+
+search_enabled: true
+search.heading_level: 3
+search.previews: 5
+search.button: true
+
 callouts:
   note:
     title: note

diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md
@@ -92,11 +92,9 @@ In order to use this script directly in your blade views, you simply need to imp
 If a module supports per method exports, like `lodash` does, it is recomended to import the single method instead of the whole module & only retrieving the desired export later.
 
 ```html
-<x-bundle import="lodash/filter" as="filter" />
-<!-- 25kb -->
+<x-bundle import="lodash/filter" as="filter" /> <!-- 25kb -->
 <!-- as opposed to -->
-<x-bundle import="lodash" as="lodash" />
-<!-- 78kb -->
+<x-bundle import="lodash" as="lodash" /> <!-- 78kb -->
 ```
 
 ### Artisan commands

diff --git a/docs/caveats.md b/docs/caveats.md
@@ -29,7 +29,7 @@ Due to Bun's path remapping behaviour Bundle is not able to split chunks from mo
 This will work perfectly fine during development, but this can't be evaluated when compiling all your code for your production environment.
 
 ```html
-<x-bundle :import="$foo" as="{{ $bar }}" />
+<x-bundle :import="$foo" as="{% raw %}{{ $bar }}{% endraw %}" />
 ```
 
 ### Running on a server

diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ title: Quickstart
 [![coverage](https://img.shields.io/codecov/c/github/media-code/workspace?token=ON4MTY8C1B&color=45%2C190%2C65)](https://codecov.io/gh/media-code/workspace)
 [![core coverage](https://img.shields.io/codecov/c/github/media-code/workspace-core?label=core%20coverage&token=ON4MTY8C1B&color=45%2C190%2C65)](https://codecov.io/gh/media-code/workspace-core)
 
-Effortless page specific JavaScript modules in Laravel/Livewire apps
+Effortless page specific JavaScript modules in Laravel/Livewire apps {: .fs-6 .fw-300}
 
 ## Quickstart