couscous/couscous

Documentation website generator

1.10.0 2023-02-21 10:54 UTC

Requires

• php: >=7.4
• erusev/parsedown: ^1.7.4
• erusev/parsedown-extra: ^0.8.1
• mnapoli/front-yaml: ^1.5
• padraic/phar-updater: ^1.0
• phine/phar: ^1.0
• php-di/php-di: ^6.0
• psr/log: ^1.0
• symfony/console: ~4.0|~5.0|~6.0
• symfony/filesystem: ~4.0|~5.0|~6.0
• symfony/finder: ~4.0|~5.0|~6.0
• symfony/process: ~4.0|~5.0|~6.0
• symfony/yaml: ~4.0|~5.0|~6.0
• twig/twig: ^1.44

Requires (Dev)

• phpunit/phpunit: ^8.5
• squizlabs/php_codesniffer: ^3.3
• vimeo/psalm: ^3.16

MIT

README

layout
home

Couscous generates a GitHub pages website from your markdown documentation.

Everything is documented on couscous.io.

What follows is the documentation for contributors.

How Couscous works?

Couscous was designed to be as simple as possible. By embracing simplicity, it becomes extremely simple to extend.

Website generation

The website generation is composed of a list of steps to process the Project model object:

interface Step
{
    /**
     * Process the given project.
     *
     * @param Project $project
     */
    public function __invoke(Project $project);
}

Steps are very granular, thus extremely easy to write and test. For example:

• LoadConfig: load the couscous.yml config file
• InstallDependencies: install the dependencies (using yarn, npm or bower)
• LoadMarkdownFiles: load the content of all the *.md files in memory
• RenderMarkdown: render the markdown content
• WriteFiles: write the in-memory processed files to the target directory
• …

For example, here is a step that would preprocess Markdown files to put the word "Couscous" in bold:

class PutCouscousInBold implements \Couscous\Step
{
    public function __invoke(Project $project)
    {
        /** @var MarkdownFile[] $markdownFiles */
        $markdownFiles = $project->findFilesByType('Couscous\Model\MarkdownFile');

        foreach ($markdownFiles as $file) {
            $file->content = str_replace('Couscous', '**Couscous**', $file->content);
        }
    }
}

Couscous uses PHP-DI for wiring everything together with dependency injection.

The full list of steps is configured in src/Application/config.php.

Website deployment

Couscous deploys by cloning (in a temp directory) the current repository, checking out the gh-pages branch, generating the website inside it, committing and pushing.

In the future, Couscous will support several deployment strategies.

Contributing

See the CONTRIBUTING file.

License

Couscous is released under the MIT License.