Skip to content

Latest commit

 

History

History
14 lines (8 loc) · 1.3 KB

README.md

File metadata and controls

14 lines (8 loc) · 1.3 KB

ChassisPHP-Website

This is the repository for the ChassisPHP documentation site. ChassisPHP Website

We welcome your help with our documentation. The instructions are very new and are lacking in many areas. If you want to contribute, add an issue describing your change (or choose an existing issue, and let us know in the issue comments that you will be working on it) set up MkDocs on your system, edit existing entries or create your own, then submit a pull request. We want to keep the style consistent. So, you may be asked to edit your submission, or your submission may be edited before it is commited.

ChassisPHP uses MkDocs as a static site generator for our documentation.

MkDocs Setup

If you use a package manager(such as apt-get, dnf, homebrew, yum, chocolatey, etc.) setting up MkDocs is straightforward. Search for "MkDocs" and install per your systems' package manager instructions.

If you don't use a package manaager, MkDocs can be installed using Python's pip.

Full instructions are available on the MkDocs website. MkDocs Installation