Inkstone Docs
Search... ⌘K
Getting Started

Getting Started#

Use this section to choose the right Inkstone workflow and build your first static documentation site.

Choose A Workflow#

Use the standalone CLI when your project does not have a Laravel application:

vendor/bin/inkstone docs:build --source=docs --output=build/docs

Use Artisan inside a Laravel application:

php artisan docs:install
php artisan docs:build

Both workflows produce the same static output.

Typical First Build#

Create a docs directory:

docs/
  README.md
  installation.md
  configuration.md

Then run a build:

vendor/bin/inkstone docs:build --source=docs --output=build/docs

Open or serve build/docs to preview the generated site.

Next Pages#