⚡️ Candy-board automatic generator ⚡️

---

GitHub action to automatically beautify your documentation generated with Candy-doc.

Configuration

To make your documentation beautiful, you need to configure environment variables of the action.

CANDY_DOC_INPUT_PATH: the path to the documentation generated by the plugin.

CANDY_DOC_OUTPUT_PATH: the path to the output directory.

CANDY_DOC_BOARD_VERSION: the name of the output file.

Usage

Create .github/workflows/board-gen.yml

Create a workflow (eg: .github/workflows/board-gen.yml see Creating a Workflow file). Here is an example of configuration

name: generate-candy-board
on:
  pull_request:
    types: ['opened', 'edited', 'reopened', 'synchronize']

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: Candy-doc/candy-action@v1
      env:
        CANDY_DOC_INPUT_PATH: ./input.json
        CANDY_DOC_OUTPUT_PATH: ./target/
        CANDY_DOC_BOARD_VERSION: 1.O.1