Code Monkey home page Code Monkey logo

codex's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.