codex/codex

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.
There is no license information available for the latest version (2.0.0-beta) of this package.

Codex documentation application based on Laravel 5.

2.0.0-beta 2016-07-03 09:54 UTC

This package is auto-updated.

Last update: 2021-11-16 23:47:34 UTC


README

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