Add readme

barryvdh · Dec 8, 2024 · 852ed09 · 852ed09
1 parent 6198c80
commit 852ed09
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/readme.md b/readme.md
@@ -0,0 +1,12 @@
+## Laravel Debugbar Docs
+
+Built using https://squidfunk.github.io/mkdocs-material/
+
+
+### Preview
+Run `mkdocs serve` to preview the docs.
+
+### Build
+
+Build is automatically created on gh-pages after pushing to the docs branch, using the workflow.
+To for a deployment, run `mkdocs gh-deploy --force` to push it th `gh-pages` directly.