# Couscous

PHP tool that generates a documentation website from Markdown files and publishes it on GitHub Pages.


Source: https://findsoftware.frbit.cloud/couscous/
Last reviewed: 2026-10-20
Updated: 2026-10-25
Listed since: 2026-10-20

## Record

### Links

- home: https://couscous.io
- repository: https://github.com/CouscousPHP/Couscous
- docs: https://couscous.io/docs/

### Identity

- status: active
- maintainer: Matthieu Napoli
- maintainerType: unknown
- parent: unknown
- firstRelease: 2014
- hqCountry: unknown

### Kind

- category: ssg
- hosting: static
- language: php
- runtime: php
- runtimeMin: php 7.4
- basedOn: unknown

### Content

- contentStore: flat-file
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: twig
- i18n: unknown

### Rendering and deploy

- runsAs: static, local
- renderingModes: static
- installMethod: phar download

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 1
- latestReleaseDate: 2023-02-21

### Adoption

- githubStargazers: 839
- packagistDownloads: 72085
- npmWeeklyDownloads: not applicable
- contributors: 44
- pluginCount: unknown
- packagistMonthlyDownloads: 361
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 169
- dependentPackages: 36

### Sources

- urls: https://api.github.com/repos/CouscousPHP/Couscous (read 2026-10-20)
- urls: https://api.github.com/repos/CouscousPHP/Couscous (read 2026-10-20)
- urls: https://couscous.io (read 2026-10-20)
- maintainer: https://github.com/CouscousPHP/Couscous/blob/master/LICENSE (read 2026-10-20)
- firstRelease: https://repo.packagist.org/p2/couscous/couscous.json (read 2026-10-20)
- category: https://couscous.io (read 2026-10-20)
- language: https://api.github.com/repos/CouscousPHP/Couscous (read 2026-10-20)
- runtime: https://github.com/CouscousPHP/Couscous/blob/1.10.0/composer.json (read 2026-10-20)
- runtimeMin: https://github.com/CouscousPHP/Couscous/blob/1.10.0/composer.json (read 2026-10-20)
- templating: https://couscous.io (read 2026-10-20)
- contentStore: https://couscous.io (read 2026-10-20)
- installMethod: https://couscous.io (read 2026-10-20)
- renderingModes: https://couscous.io (read 2026-10-20)
- runsAs: https://couscous.io (read 2026-10-20)
- runsAs: https://couscous.io (read 2026-10-20)
- license: https://github.com/CouscousPHP/Couscous/blob/master/README.md (read 2026-10-20)
- currentMajor: https://repo.packagist.org/p2/couscous/couscous.json (read 2026-10-20)
- latestReleaseDate: https://api.github.com/repos/CouscousPHP/Couscous/releases/latest (read 2026-10-20)
- githubStargazers: https://api.github.com/repos/CouscousPHP/Couscous (read 2026-10-20)
- contributors: https://api.github.com/repos/CouscousPHP/Couscous/contributors (read 2026-10-20)
- packagistDownloads: https://packagist.org/packages/couscous/couscous.json (read 2026-10-20)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/packagist.org/packages/couscous%2Fcouscous (read 2026-10-25)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/packagist.org/packages/couscous%2Fcouscous (read 2026-10-25)
- packagistMonthlyDownloads: https://packagist.org/packages/couscous/couscous/stats.json (read 2026-10-25)

## Notes

Couscous builds its site from Markdown files kept in a repository next to the code, and the generated site is static. Templates use Twig.

The project is downloaded as a phar file. A preview command renders the site on the developer's machine, and a deploy command publishes the site on the `gh-pages` branch, where GitHub Pages serves it. The [homepage](https://couscous.io) describes these steps.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0