README

Docsidian is an opinionated Laravel-based documentation site generator, optimized for how we use Obsidian. It allows us to simply create a git repository in any folder of our Obsidian vault to create docs for a project or mount a folder in any project's documentation folder as an Obsidian vault and just build.

Not Ready For You To Use

This is still in very early development. We're dogfooding it on a few projects already, but it is going to change quickly for a while and will definitely break. We will make an announcement when it's ready.

Docsidian is Part of Scalpels

Installation

You can install the package via composer:

composer require artisan-build/docsidian

You can publish and run the migrations with:

php artisan vendor:publish --tag="docsidian-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="docsidian-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="docsidian-views"

Usage

$docsidian = new ArtisanBuild\Docsidian();
echo $docsidian->echoPhrase('Hello, ArtisanBuild!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

artisan-build / docsidian

Maintainers

Details