Skip to content

Implement AssEmbly syntax highlighting in docs #54

Implement AssEmbly syntax highlighting in docs

Implement AssEmbly syntax highlighting in docs #54

Workflow file for this run

name: Build and Deploy Docs
on:
# Runs on pushes targeting the default branch
push:
branches:
- "main"
paths:
- Documentation/ReferenceManual/**
- Documentation/PointerToy/**
- .github/workflows/static.yml
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Setup PanDoc
uses: pandoc/actions/setup@main
- name: Setup Node.js 18.x
uses: actions/setup-node@v4
with:
node-version: 18.x
- name: Install dependencies
run: npm install -g typescript
- name: Build Reference Manual HTML
run: |
mkdir ./Documentation/ReferenceManual/Build
pandoc -s ./Documentation/ReferenceManual/ReferenceManual.md \
--highlight-style=./Documentation/ReferenceManual/pandoc.theme \
--syntax-definition=./Documentation/ReferenceManual/AssEmblySyntax.xml \
--toc --toc-depth=6 \
--css=./Documentation/ReferenceManual/ReferenceManual.css --embed-resource \
-H ./Documentation/ReferenceManual/ReferenceManual.HtmlHeader.html \
-o ./Documentation/ReferenceManual/Build/ReferenceManual.html \
--metadata pagetitle="AssEmbly Reference Manual"
- name: Build Pointer Toy
run: tsc -p ./Documentation/PointerToy/
- name: Copy artifacts
run: |
mkdir ./Documentation/PagesArtifacts
cp ./Documentation/ReferenceManual/Build/ReferenceManual.html ./Documentation/PagesArtifacts/index.html
cp -r ./Documentation/PointerToy/ ./Documentation/PagesArtifacts/PointerToy/
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload the built reference manual and pointer toy HTML
path: './Documentation/PagesArtifacts/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4