layout |
---|
home |
Couscous generates a GitHub pages website from your markdown documentation.
For details on setting up Couscous to contribute to LaunchCode Education sites, see Using Couscous for LaunchCode projects.
![Gitter](https://badges.gitter.im/Join Chat.svg)
Everything is documented on couscous.io.
What follows is the documentation for contributors.
Couscous was designed to be as simple as possible. By embracing simplicity, it becomes extremely simple to extend.
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
: loads thecouscous.yml
config fileRunBowerInstall
LoadMarkdownFiles
: load the content of all the*.md
files in memoryRenderMarkdown
: render the markdown contentWriteFiles
: 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
.
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.
See the CONTRIBUTING file.
Couscous is released under the MIT License.