Extendable Documentation Platform written in Laravel 5. Generate easy and awesome documentation!
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app Initial commit Jun 6, 2016
bin
bootstrap Initial commit Jun 6, 2016
config
database Initial commit Jun 6, 2016
public working to beta Jul 3, 2016
resources working to beta Jul 3, 2016
scripts composer and gitignores updated Jun 24, 2016
storage
tests Initial commit Jun 6, 2016
.env.example
.gitattributes Initial commit Jun 6, 2016
.gitignore
LICENSE.md Initial commit Jun 6, 2016
README.md
artisan Initial commit Jun 6, 2016
composer.json
composer.lock
gulpfile.js Initial commit Jun 6, 2016
package.json Initial commit Jun 6, 2016
phpunit.xml Initial commit Jun 6, 2016
server.php Initial commit Jun 6, 2016

README.md

Codex 2 - BETA!

GitHub Version Total Downloads Documentation Source License

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

License

Copyright (c) 2015 Robin Radic, MIT License