diff --git a/readme.md b/readme.md new file mode 100644 index 00000000..1d28dd6c --- /dev/null +++ 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. \ No newline at end of file