Installation
Require the package with Composer:
composer require petebishwhip/laradocs
Run the installer to publish the config file and scaffold a starter page:
php artisan docs:install
That's it. Visit /docs in your browser and you'll see your documentation.
Creating pages
Every markdown file under your docs/ directory becomes a page. Use the
generator to scaffold one with front-matter already filled in:
php artisan make:doc guide/installation --title="Installation" --order=1
Folders become navigation sections. A file named _index.md inside a folder
becomes that section's landing page.
The front-matter and body that make:doc writes come from a Blade stub you
can publish and edit — see Customising stubs.
Finding pages
The header includes a command palette — press ⌘K (or Ctrl K on Windows / Linux) anywhere on the docs site to open it, then type to fuzzy-filter every page. Use the top tabs to switch between major sections, the left sidebar to navigate within a section, and the right-hand TOC to jump between headings on the current page.
What next?
- Configure routes, caching and the UI in Configuration.
- Learn how URLs are generated in Routing.
- Discover every Artisan command in CLI.
- Inject dynamic values with Variables.
- Restyle the bundled views in Customising the UI.