2017 © Pedro Peláez
 

library couscous

image

couscous/couscous

  • Tuesday, June 5, 2018
  • by mnapoli
  • Repository
  • 36 Watchers
  • 659 Stars
  • 29,836 Installations
  • PHP
  • 30 Dependents
  • 0 Suggesters
  • 88 Forks
  • 37 Open issues
  • 29 Versions
  • 5 % Grown

The README.md

layout: home

Couscous generates a GitHub pages website from your markdown documentation., (*1)

Build Status Average time to resolve an issue Percentage of issues still open, (*2)

Everything is documented on couscous.io., (*3)

What follows is the documentation for contributors., (*4)

How Couscous works?

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

Website generation

The website generation is composed of a list of steps to process the Project model object:, (*6)

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:, (*7)

  • 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:, (*8)

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., (*9)

The full list of steps is configured in src/Application/config.php., (*10)

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., (*11)

In the future, Couscous will support several deployment strategies., (*12)

Contributing

See the CONTRIBUTING file., (*13)

License

Couscous is released under the MIT License., (*14)

The Versions

05/06 2018

dev-master

9999999-dev

  Sources   Download

MIT

The Requires

 

The Development Requires

14/01 2018

dev-mnapoli-patch-1

dev-mnapoli-patch-1

  Sources   Download

MIT

The Requires

 

The Development Requires

19/03 2017

1.6.1

1.6.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

24/01 2017

1.6.0

1.6.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

02/06 2016

1.5.2

1.5.2.0

  Sources   Download

MIT

The Requires

 

The Development Requires

31/05 2016

dev-feature/markdown-model

dev-feature/markdown-model

  Sources   Download

MIT

The Requires

 

The Development Requires

31/05 2016

1.5.1

1.5.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

03/04 2016

1.5.0

1.5.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

01/02 2016

1.4.1

1.4.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

30/12 2015

1.4.0

1.4.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

11/10 2015

1.3.2

1.3.2.0

  Sources   Download

MIT

The Requires

 

The Development Requires

09/10 2015

1.3.1

1.3.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

13/09 2015

1.3.0

1.3.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

26/07 2015

1.2.0

1.2.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

20/07 2015

1.1.4

1.1.4.0

  Sources   Download

MIT

The Requires

 

The Development Requires

10/06 2015

1.1.3

1.1.3.0

  Sources   Download

MIT

The Requires

 

The Development Requires

11/05 2015

1.1.2

1.1.2.0

  Sources   Download

MIT

The Requires

 

The Development Requires

08/02 2015

1.1.1

1.1.1.0

  Sources   Download

MIT

The Requires

 

The Development Requires

07/02 2015

1.1.0

1.1.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

07/12 2014

1.0.0

1.0.0.0

  Sources   Download

MIT

The Requires

 

The Development Requires

06/12 2014

1.0.0-rc1

1.0.0.0-RC1

  Sources   Download

MIT

The Requires

 

The Development Requires

29/11 2014

1.0.0-beta1

1.0.0.0-beta1

  Sources   Download

MIT

The Requires

 

The Development Requires

02/06 2014

0.3.3

0.3.3.0

  Sources   Download

MIT

The Requires

 

31/05 2014

0.3.2

0.3.2.0

  Sources   Download

MIT

The Requires

 

31/05 2014

0.3.1

0.3.1.0

  Sources   Download

MIT

The Requires

 

31/05 2014

0.3.0

0.3.0.0

  Sources   Download

MIT

The Requires

 

30/05 2014

0.2.0

0.2.0.0

  Sources   Download

MIT

The Requires

 

15/05 2014

0.1.1

0.1.1.0

  Sources   Download

MIT

The Requires

 

15/05 2014

0.1.0

0.1.0.0

  Sources   Download

MIT

The Requires