README

EasyDocs allows for you to create & edit user documentation with a built-in dashboard centered around the organization of documentation under various user defined topics.

No database is required to run EasyDocs. A full-installation process will take less than five minutes and will have you easily spinning up documentation in no time!

Features

There are numerous features within EasyDocs that make the creation of user documentation easy:

Database(less): One of the main features of EasyDocs is there is no need for a database of any sort.
Easy Configuration: Much of EasyDocs can be modified from one config file. This file has it's definitions layed out in very easy-to-understand terms, meaning someone without programming knowledge would be able to know what they're modifying.
ADA Compliancy: Documentation generated for the user is fully-ada compliant by default.
MVC-Like architecture: The structure of the EasyDocs source means modification is easy. No sifting through a gargled code-base for editing the visuals of a specific template.

Prerequisites

A web server with PHP 7.1.3+ installed
File reading/writing permissions(Required for the docs/ folder included in EasyDocs)
Composer

Installation

With Composer

Run the following command to download the composer package:

composer create-project chx2/easydocs

Edit the config.yaml file under the app/ directory to update your username & password plus add any additional users. A default one is provided but is recommended that you change it. You can edit current users & add new ones under the YAML block called users:

admin: '1234'

Once you have logged in for the first time, you can create and add new users as well as change passwords.

Enter the URL of the webserver to login. Once you have created your first section inside the ACP (Accessible by appending /login to url), you can begin to write your documentation!

Modifications

It is possible to modify the layout and/or functionality of EasyDocs if you wish.

Under the settings in the dashboard, you can upload your own custom theme! A default one is bundled with the application. Documentation on creating custom themes is coming soon! As of now, you can customize:

Styling and scripts
Templates
Router File(Optional)

Manual Documentation

While the intended purpose of EasyDocs is to provide an editor to help you create documentation, it is entirely possible to create documentation manually if you choose to do so. Keep in mind you should follow the these steps to ensure your additions do not cause any issues within the application:

In your config.yaml file, add your new page name to an existing section under the Pages variable. If you want to create a new section, you will need to add that as well.

Pages: Default: [Test]

Under the docs/ folder, add your page name to the folder of the section you specified. If you are making a new section, you will need to create a new folder.

docs/Default/Test.md

Edit your new documentation file and save when complete. Your document will show up the next time you visit the application.

Credits

There are several plugins that are utilized within EasyDocs for simplified usage:

Back-End

Front-End

Bug reporting

Feel free to leave a issue if something is not working with EasyDocs by default

Note, I will not respond to reports if the error occurred after custom modification of EasyDocs. The only exception I will allow is if something within EasyDocs is not behaving as seemingly intended, therefore causing errors.

Leave any reports on https://github.com/chx2/EasyDocs/issues

Contributing

Head over here https://github.com/chx2/EasyDocs/pulls

chx2 / easydocs

Maintainers

Details