Couscous - Github Action

Couscous turns Markdown documentation into websites. http://couscous.io/

This is a GitHub Action to generate couscous websites. View : https://couscousphp.github.io/GitHub-Action/

Getting started

Add your workflow file, the following step

  - uses: CouscousPHP/GitHub-Action@v1

Examples

Publish on GithubPage

name: Couscous GithubPage

on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v1

      - uses: CouscousPHP/GitHub-Action@v1
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./.couscous/generated

Artefact zip

Generate zip artefact with the generate website.

name: Couscous Artefact

on:
  push:
    branches:
      - master

jobs:
  deploy:
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v1

      - uses: CouscousPHP/GitHub-Action@v1

      - name: Upload artifact
        uses: actions/[email protected]
        with:
          # Artifact name
          name: Couscous
          # Directory containing files to upload
          path: .couscous/generated

License

Couscous is released under the MIT License.