codex/core

The core package for codex. This is the minimum required package to get codex up and running.

title: Overview, _(*1)

subtitle: Codex Documentation

Codex Documentation

Head over to codex-project.ninja for the full documentation (starting with this document) to get started., _(*2)

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., _(*3)

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., _(*4)

Codex > Projects > Revisions > Documents > Processors > Output, _(*5)

• Codex can provide documentation for multiple Projects.
• Each Project has one or more Revisions (versions)
• Each Revision contains Documents.
• Each Document is passed trough Processors, modifying it's content before displaying.

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!

Copyright/License

Copyright 2019 Robin Radic - MIT Licensed , _(*6)