Open source documentation with Couscous
Attempted on a mid-2014 Macbook Pro running OSX Yosemite.
curl -OS http://couscous.io/couscous.phar
This failed for me and so I had to download the file through my browser Change permissions for Couscous and move to root path
chmod +x couscous.phar sudo mv couscous.phar /usr/local/bin/couscous
This failed because I needed to edit my
php -i | grep "php.ini"
found the file in
/etc/. I added to it the line
date.timezone = "America/Los_Angeles"
Navigate to local copy of a GitHub repo containing
.md files and run the following command:
And then visit a version of the site running at http://localhost:8000/
If you edit any of the underlying
.md files, the preview version updates automatically (just refresh the page in your browser)
Test the site appearance
Any file named
README.md gets converted to
index.html. Sub-pages of the documentation are any other
.md files in the directory, they can be found at http://localhost:8000/myproject/otherMDfile.html
Make sure that the directory holding the
.couscous file is a functional GitHub repository. For a project with a single algorithm in multiple languages, I made a separate repository for documentaion.
which sends the site to http://your-username.github.io/your-project/
Depending on your website hosting structure, you may need to update the ‘main’ branch as well using a standard commit in the terminal.
Now customize using a
couscous.yml file in root directory