Get Started¶

Zensical GitHub Action to checkout, build, upload, and deploy Zensical Docs to GitHub Pages.

Features¶

• Build Documentation
• Upload the Artifact
• Deploy to GitHub Pages
• Run Prepare/Post Scripts

You can customize or disable each step with the Inputs.

Workflow¶

Add the step to an existing workflow or create a new one.

If creating a new workflow, place it in the .github/workflows directory.

name: 'Docs'

on:
  workflow_dispatch:
  push:
    branches: ['master']

jobs:
  docs:
    name: 'Docs'
    runs-on: ubuntu-latest

    permissions:
      pages: write
      id-token: write

    environment:
      name: github-pages
      url: ${{ steps.zensical.outputs.page_url }}

    steps:
      - name: 'Zensical Action'
        id: zensical
        uses: cssnr/zensical-action@v1

See the Usage for more options or check out some additional Examples.