motor-cms/motor-docs

Motor documentation package

1.1.0 2021-04-17 18:00 UTC

Requires

• php: ^7.4|^8.0
• erusev/parsedown-extra: ^0.7.1
• laravel/framework: ^8.0

MIT

• Reza Esmaili

• motor

README

Simple Laravel package for adding multi-package documentation to your projects. Also does search!

Installation

You can install this package via composer using this command:

composer require motor-cms/motor-docs

Publish the necessary assets (just a css and a js file)

php artisan vendor:publish --tag=motor-docs

Configuration

Next, create a file 'motor-docs.php' in your config directory

<?php

return [
    'route'     => 'documentation',
    'name'      => 'Motor-Docs',
    'logo'      => 'images/motor-logo-white-cropped.png',
    'copyright' => 'Reza Esmaili',
    'packages' => [
        'motor-docs' => [ // this should match with your package name. use 'local' for the main app
            'position'   => 1, // sets the sorting position for this package
            'name'       => 'Motor-Docs',
            'navigation' => '_navigation' // name of your sidebar navigation markdown file
        ]
    ]

];

Repeat for your other packages. It is safe to only include the 'packages' array. (You can also put all your packages in your main motor-docs.php file)

<?php
return [
    'packages' => [
        'second-package' => [ // this should match with your package name. use 'local' for the main app
            'position'   => 2, // sets the sorting position for this package
            'name'       => 'Second package',
            'navigation' => '_navigation' // name of your sidebar navigation markdown file
        ]
    ]
];

Add the following code to the boot() method of your service providers. Do this for each of your packages.

$config = $this->app['config']->get('motor-docs', []);
$this->app['config']->set('motor-docs',
    array_replace_recursive(require __DIR__.'/../../config/motor-docs.php', $config));

Writing documentation

Add Markdown (.md) files in your resource/documentation folder. The package will automatically render a navigation tree defined in your _navigation.md file(s).

Have fun!

Reading your docs

By default, your docs are available at https://[HOST]/documentation You can change the route in your main motor-docs.php config file.

Todo

• ajax search
• Better docs (lol)
• Information on how to build the assets with laravel mix
• Include assets and add publish method to the ServiceProvider
• Sort documentation packages by position

Credits

• Reza Esmaili

About Motor

...

License

...