Skip to content

User guide doc (#993) #33

User guide doc (#993)

User guide doc (#993) #33

name: πŸ“” Compile MKDocs to PDF
# This workflow is triggered on pushes to the repository.
on:
push:
branches:
- main
# Paths can be used to only trigger actions when you have edited certain files, such as a file within the /docs directory
paths:
- ".github/workflows/CompileMKDocsToPDF.yml"
- "docs/**.md"
- "docs/assets/**"
# Allow manually running in the actions tab
workflow_dispatch:
jobs:
generatepdf:
name: Build PDF
runs-on: ubuntu-latest
steps:
- name: Checkout πŸ›’
uses: actions/checkout@v4
- name: Create Mkdocs Config πŸš€
working-directory: ./docs
run: ./create-mkdocs-pdf-config.sh
- name: Build PDF πŸ“ƒ
uses: kartoza/mkdocs-deploy-build-pdf@master
# Uses orzih's mkdocs PDF builder
# https://github.com/orzih/mkdocs-with-pdf
env:
CONFIG_FILE: mkdocs.yml
EXTRA_PACKAGES: build-base
#REQUIREMENTS: folder/requirements.txt
- name: Upload PDF Artifact ⚑
uses: actions/upload-artifact@v4
with:
name: docs
path: docs/pdfs