This is Couscous
Couscous is good.
What?

Put your documentation online

Couscous turns Markdown documentation into beautiful websites. It's GitHub Pages on steroids.


  • README.md

    Step 1

    Write documentation

    Write your documentation in Markdown inside your repository, versioned with your code. Couscous will turn those Markdown files to HTML.

  • Step 2

    Preview

    couscous preview will render the website on your machine. Tweak the default template, fix some typos and the changes will be reflected in real time.

  • Step 3

    Publish

    couscous deploy will publish your website on the gh-pages Git branch. GitHub will automatically put it online and host it for you.

  • Step 4

    Profit

    Your website is online, just sit back and relax.

Why?

Why another static website generator?

Couscous is different from other static websites generators like Sculpin, Phrozn or Jekyll. These are generic static websites generator, sometimes meant for blogs, and using them to put documentation online is clunky. They also all require a specific directory layout which is incompatible with how we usually store documentation alongside our code.

Couscous is built for simplicity.

It has no requirement on your directory layout, it takes a single command to preview the website and a single one to deploy to GitHub pages.

Curious?

Try it out in one of your projects.

Simply run:

curl -OS http://couscous.io/couscous.phar
php couscous.phar preview

Please note that as Github is using a DDOS protection system, if using CURL fails, just manually download the phar file.

The website should be running at http://localhost:8000/

Built with Couscous

Have a look at those websites built with Couscous.

PHP-DI

The PHP dependency injection container for humans

Redaktilo

An easy "line manipulation" PHP lib: jump, insert and do anything!

MyCLabs\Work

A PHP work queue library for abstracting backends

jquery.confirm

Confirm dialogs for buttons and links using jQuery and Bootstrap

Foil

PHP Template Engine for Native PHP Templates.

Add your own

Send a pull request to add your own.

Features

For those who like feature lists:

Markdown Extra support

Fenced code blocks

Bower support

Responsive default templates

Twig templates

YAML configuration

Custom before/after scripts

Syntax highlighting