doczilla/doczilla

Beautiful lightning fast documentation, built with Laravel, Livewire and Volt.

v1.0.2 2024-01-06 11:20 UTC

Requires

• php: ^8.2
• embed/embed: ^4.4
• guzzlehttp/guzzle: ^7.8.1
• laravel/framework: ^10.35
• laravel/octane: ^2.2
• laravel/sanctum: ^3.3.2
• laravel/tinker: ^2.8.2
• livewire/livewire: ^3.2.6
• livewire/volt: ^1.6
• loilo/fuse: ^7.0
• symfony/dom-crawler: ^7.0
• symfony/yaml: ^7.0

Requires (Dev)

• fakerphp/faker: ^1.23.0
• jetstreamlabs/pinte: ^1.1
• laravel/sail: ^1.26.3
• mockery/mockery: ^1.6.6
• nunomaduro/collision: ^7.10
• pestphp/pest: ^2.28
• pestphp/pest-plugin-faker: ^2.0
• pestphp/pest-plugin-laravel: ^2.2
• pestphp/pest-plugin-livewire: ^2.1
• pestphp/pest-plugin-type-coverage: ^2.5
• pestphp/pest-plugin-watch: ^2.0.1
• spatie/laravel-ignition: ^2.3.1

MIT

• volt
• tailwindcss
• doczilla

README

Doczilla Documentation Platform

Pending our wip installer package you can follow the directions below to get set up.

Local Development

To get started you'll need node and npm installed on your system, along with composer of course. Since this is a Laravel based platform we're assuming you'll be developing locally on Valet. If not, then you'll know where to go to clone your repos.

1. Fork this repository
2. Open your terminal and cd to your ~/Sites folder
3. Clone your fork into the ~/Sites/doczilla folder, by running the following command with your username placed into the {username} slot:

   git clone [e-mail]:{username}/doczilla.git doczilla

4. CD into the new directory you just created:

   cd doczilla

5. Run the setup script located in the package.json file, which will take all the steps necessary to prepare your local install:

   npm run setup

6. Alternately you can run the docs:setup artisan command directly preceeded by composer install:

composer install && php artisan docs:setup

Syncing Upstream Changes Into Your Fork

This GitHub article provides instructions on how to pull the latest changes from this repository into your fork.

Updating After Remote Code Changes

If you pull down the upstream changes from this repository into your local repository, you'll want to update your Composer and NPM dependencies, as well as update your documentation branches. For convenience, you may run the update script in package.json which aliases to running the artisan docs:update command.

npm run update

or you can run the update artisan command directly:

php artisan docs:update