Thavarshan / manuscrite

📒 Laravel powered documentation site builder.

Manuscrite

Introduction

Manuscrite is in fact a SPA powered by Vue, InertiaJS and webpack. It is composed of two parts: a minimalistic static site generator with a Vue-powered theming system, and a default theme optimized for writing technical documentation. It was created to support the documentation needs of any project.

Installation

Please check the official Laravel installation guide for server requirements before you start. Official Documentation

Clone the repository

git clone https://github.com/Thavarshan/manuscrite.git

Switch to the repo folder

cd manuscrite

Install all the dependencies using composer

composer install

Copy the example env file and make the required configuration changes in the .env file

cp .env.example .env

Generate a new application key

php artisan key:generate

Run the database migrations (Set the database connection in .env before migrating)

php artisan migrate

Start the local development server

php artisan serve

You can now access the server at http://localhost:8000

TL;DR command list

git clone https://github.com/Thavarshan/manuscrite.git
cd manuscrite
composer install
cp .env.example .env
php artisan key:generate

Make sure you set the correct database connection information before running the migrations Environment variables

php artisan migrate
php artisan serve

Security Vulnerabilities

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

License

Manuscrite is open-sourced software licensed under the MIT license.