Couscous从您的markdown文档生成一个GitHub页面的网站。(Couscous generates a GitHub pages website from your markdown documentation.)
Couscous从您的markdown文档生成一个GitHub页面的网站。她把Markdown文档变成漂亮的网站。 它是更强大有力的GitHub Pages。Couscous支持Markdown中的GitHub fenced代码块。Couscous在您的机器上需要PHP 5.4或更高版本。
Couscous不同于其他静态网站生成器如Sculpin或Jekyll。 这些是通用的静态网站生成器，有时是为博客，使用他们把文档放到网上是有些繁杂的。他们也都需要一个特定的目录布局，这与我们通常在我们的代码旁边存储文档不兼容。
Couscous是为简单而建。
它不需要你的目录布局，它只需要一个命令来预览网站和一个命令部署到GitHub页面。
Couscous特性：
对于喜欢功能列表的用户：
| Name With Owner | CouscousPHP/Couscous |
|---|---|
| Primary Language | PHP |
| Program language | PHP (Language Count: 7) |
| Platform | |
| License: | Other |
| Created At | 2014-01-17 00:06:26 |
|---|---|
| Pushed At | 2024-08-01 22:05:46 |
| Last Commit At | 2023-02-21 11:54:36 |
| Release Count | 40 |
| Last Release Name | 1.10.0 (Posted on ) |
| First Release Name | 0.1.0 (Posted on ) |
| Stargazers Count | 836 |
|---|---|
| Watchers Count | 31 |
| Fork Count | 103 |
| Commits Count | 548 |
| Has Issues Enabled | |
| Issues Count | 146 |
| Issue Open Count | 43 |
| Pull Requests Count | 101 |
| Pull Requests Open Count | 6 |
| Pull Requests Close Count | 17 |
| Has Wiki Enabled | |
|---|---|
| Is Archived | |
| Is Fork | |
| Is Locked | |
| Is Mirror | |
| Is Private |
Couscous generates a GitHub pages website from your markdown documentation.
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 the couscous.yml config fileRunBowerInstallLoadMarkdownFiles: load the content of all the *.md files in memoryRenderMarkdown: render the markdown contentWriteFiles: write the in-memory processed files to the target directoryFor 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.