README

Introduction

Codex is a file-based documentation platform built on top of Laravel. It's completely customizable and dead simple to use to create beautiful documentation.

Codex is able to do things like transforming markdown or automaticaly fetching documentation from a Bitbucket/Github repositories. Most of it's features are provided by addons. Codex is extenable, themeable, hackable and simple to setup and use.

The package follows the FIG standards PSR-1, PSR-2, and PSR-4 to ensure a high level of interoperability between shared PHP code.

Features

Laravel 5
Markdown, Creole or custom document parsers
Host a unlimited number of projects/manuals with accompanying versions
Extenable, themeable, hackable
Simple to setup and use
Syntax Highlighting
Easy navigation defined in YAML
SEO Friendly URLs
Default theme build on Laravels theme
Multiple storage methods (local, dropbox, amazon, etc)
Can be installed as stand-alone or sub-component in your own (Laravel) project.
(Addon Feature) Github/Bitbucket (auto webhook) synchronisation based on tags/branches.
(Addon Feature) Smooth working, custom PHPDoc integration
(Addon Feature) Access restriction on projects using Github/Bitbucket login
Much, much more!

Documentation

Check out the official documentation.

Installation

composer create-project codex/codex --stability=beta
cd codex
php artisan serve

codex / codex

Maintainers

Details

README

Introduction

Features

Documentation

Installation

License