reliqarts / docweaver
An easy-to-use product documentation package for Laravel.
Fund package maintenance!
reliq
Requires
- php: ^8.1
- ext-json: *
- illuminate/support: 9 - 10
- league/commonmark: ^2.2
- monolog/monolog: 1.24 - 3
- nesbot/carbon: ^2.0
- reliqarts/laravel-common: 5.0 - 6
- symfony/browser-kit: >=4.3
- symfony/process: >=4.0
- symfony/yaml: >=4.3
Requires (Dev)
- orchestra/testbench-browser-kit: 4 - 8
- phpro/grumphp: ^1.0
- phpspec/prophecy-phpunit: ^2.0
- phpunit/phpunit: ^9.3
- symplify/easy-coding-standard: >=10.2
- dev-main
- v5.1.1
- v5.1.0
- v5.0.0
- v4.1.0
- v4.0.0
- v3.1.0
- v3.0.0
- v3.0.0-beta
- 2.x-dev
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.1
- v2.0.0
- v2.0.0-beta.2
- v2.0.0-beta.1
- v2.0.0-beta
- v1.4.1
- v1.4.0
- v1.3.1
- v1.3.0
- v1.2.3
- v1.2.2
- v1.2.1
- v1.2.0
- v1.1.1
- v1.1.0
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
- v1.0.0-beta.2
- v1.0.0-beta.1
- v1.0.0-beta
This package is auto-updated.
Last update: 2024-03-04 01:49:55 UTC
README
An easy-to-use product documentation package for Laravel.
Docweaver is suitable for product documentation and/or knowledge bases. Converts folder(s) of .md files into full-bread complete documentation. Docweaver is inspired by Laravel's very own documentation.
Key Features
Docweaver provides the following features and more out of the box.
- Multi-product support
- Docweaver supports multiple products out-the-box. Just create your product folders and drop in your documentation version directories.
- Plug and play
- Just install and configure and you're golden! (approx. 2min)
Installation & Usage
Installation
Install via composer; in console:
composer require reliqarts/laravel-docweaver
or require in composer.json:
{ "require": { "reliqarts/laravel-docweaver": "^2.0" } }
then run composer update
in your terminal to pull it in.
Once this has finished, you will need to add the service provider to the providers array in your app.php config as follows: (n.b. This package supports Laravel's package auto-discovery; if you are using Laravel 5.5 or above you can skip this step.)
ReliqArts\Docweaver\ServiceProvider::class,
Ensure that your applications public storage directory is linked and accessible via the browser.
php artisan storage:link
see: https://laravel.com/docs/master/filesystem
Finally, publish package resources and configuration:
php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider"
You may opt to publish only configuration by using the docweaver-config
tag:
php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider" --tag="docweaver-config"
Setup
Set the desired environment variables so the package knows your image model, controller(s), etc.
Example environment config:
DOCWEAVER_ROUTE_PREFIX=docs
DOCWEAVER_DIR=resources/docs
These variables, and more are explained within the config file.
Documentation Directory
The documentation directory is the place where you put your project documentation directories. It may be changed with the config key docweaver.storage.dir
or the environment variable DOCWEAVER_DIR
. The default documentation directory is resources/docs
.
Structure
Each project directory should contain separate folders for each documented version. Each version must have at least two (2) markdown files, namely documentation.md
and installation.md
, which serve as the sidebar and initial documentation pages respectively.
[doc dir]
│
└─── Project One
│ └── 1.0
│ └── 2.1
│ └── .docweaver.yml # meta file (optional)
│ └── documentation.md # sidebar nav
│ └── installation.md # initial page
│
└─── Project Two
Meta File
Configurations for each doc version may be placed in .docweaver.yml
. The supported settings are:
-
name
Product name.
-
description
Product description.
-
image_url
Product image url. This may be an absolute url (e.g.
http://mywebsite.com/myimage.jpg
) or an image found in theimages
resource directory.To use the
foo.jpg
in the images directory you would setimage_url
to{{docs}}/images/foo.jpg
.For more info. see: Assets
Acknowledgements
This package was inspired by Laravel's documentation and uses its underlying mechanism as a base.