PHPackages                             mykemeynell/inkstone - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. mykemeynell/inkstone

ActiveLibrary[Parsing & Serialization](/categories/parsing)

mykemeynell/inkstone
====================

Generate beautiful deployable Laravel documentation sites from Markdown with minimal configuration.

v1.2.0(1mo ago)01MITPHPPHP >=8.2CI passing

Since May 29Pushed 1mo agoCompare

[ Source](https://github.com/mykemeynell/inkstone)[ Packagist](https://packagist.org/packages/mykemeynell/inkstone)[ RSS](/packages/mykemeynell-inkstone/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (3)Dependencies (21)Versions (8)Used By (0)

Inkstone
========

[](#inkstone)

Inkstone generates static documentation sites from Markdown for Laravel projects and standalone PHP package repositories.

[View the Demo Documentation](https://mykemeynell.github.io/inkstone/)

Install
-------

[](#install)

```
composer require mykemeynell/inkstone --dev
```

Standalone Usage
----------------

[](#standalone-usage)

Use the package binary when the target project is not a full Laravel application:

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

Useful options:

- `--source=docs` sets the Markdown source directory.
- `--output=build/docs` sets the generated static site directory.
- `--base-url=/docs` sets the base URL when the generated site is mounted below a subdirectory.
- `--config=inkstone.php` loads an optional PHP config file and merges it over the defaults.

Laravel Usage
-------------

[](#laravel-usage)

Inside a Laravel application, use the Artisan commands registered by the service provider:

```
php artisan docs:install
php artisan docs:build
php artisan docs:serve
php artisan docs:clean
```

`docs:install` publishes Inkstone configuration, starter docs, theme assets, and deployment examples. `docs:build` writes deployable static HTML into `build/docs` by default.

Configuration
-------------

[](#configuration)

Inkstone uses `config/inkstone.php` inside Laravel applications. In standalone package repositories, create `inkstone.php` or `config/inkstone.php` in the package root.

```