Couscous is focused specifically on turning project documentation written in Markdown into a static website. Unlike more general-purpose generators, its workflow is designed around documentation already stored alongside source code.
There is no prescribed directory structure for documentation. Couscous reads Markdown from an existing repository, processes it through its generation pipeline and can publish the result to GitHub Pages.
This is free and open source software.
Key Features
- Converts Markdown documentation into static HTML pages.
- Works with documentation stored alongside a project’s source code.
- Does not require users to reorganise documentation into a special directory hierarchy.
- A preview command renders the documentation locally for checking changes before publication.
- Deployment support can publish generated files to a repository’s gh-pages branch.
- Supports Markdown Extra and fenced code blocks.
- Uses Twig for templates, allowing the appearance of documentation sites to be customised.
- Configuration is stored in YAML.
- Supports responsive templates and syntax highlighting.
- Custom scripts can be run before and after generation.
- The generation pipeline is made from discrete processing steps, making the internals extensible for developers who need specialised behaviour.
- Uses dependency injection internally to wire the generation components together.
Website: github.com/CouscousPHP/Couscous
Support:
Developer: Matthieu Napoli
License: MIT License
Couscous is written in PHP. Learn PHP with our recommended free books and free tutorials.
Related Software
| PHP Static Site Generators | |
|---|---|
| HydePHP | Content-first Laravel-powered static site generator |
| Jigsaw | Framework for rapidly building static sites |
| Spress | Blog-aware application that transform your plain text files in static sites |
| Sculpin | Can be used to create any type of static website |
| Cecil | Simple and powerful content-driven static site generator |
| Couscous | Turns Markdown documentation into beautiful websites |
| Ata’s SSG | Static site generator for GitHub pages. |
| WP2Static | WordPress plugin for static site generation and deployment |
| Capro | Uses the Blade template engine |
| StaticForge | Processes Markdown and HTML content files through an event-driven pipeline |
| Crossroads | Builds static websites from Markdown-based content with front matter metadata |
| PHPSSG | Personal Home Page Static Site Generator |
| Basildon | Builds sites from text content files with YAML frontmatter and body conten |
Read our verdict in the software roundup.
 Explore our carefully curated directory of recommended free and open source software, covering every major software category.The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form. |
Please read our Comment Policy before commenting.