Skip to content

update home doc

update home doc #11

name: marp-and-mkdocs-to-pages
concurrency: marp-and-mkdocs-to-pages
on:
push:
branches: [ '**' ]
paths:
- slides/**
- docs/**
- mkdocs.yml
- img/**
- .github/workflows/publish-pages.yml
# also trigger if lab archives changed
- demos/**
- .devcontainer/**
workflow_dispatch:
branches: [ '**' ]
permissions:
contents: write
pages: write
id-token: write
jobs:
build:
if: github.repository != 'arista-netdevops-community/one-click-se-demos'
runs-on: ubuntu-22.04
steps:
- name: Checkout code ✅
uses: actions/checkout@v4
- name: Set variables for Mkdocs Macros ℹ️
run: |
echo "---" > docs/assets/data/github.yml
echo "org_name: ${{ github.repository_owner }}" >> docs/assets/data/github.yml
echo "repo_name: ${{ github.event.repository.name }}" >> docs/assets/data/github.yml
echo "repository: ${{ github.repository }}" >> docs/assets/data/github.yml
- name: find-branch
id: find_branch
run: |
echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT
- name: Replace URLs to match git repo ✂️
run: |
grep -rl '${localEnv:GITHUB_REPOSITORY}' . --exclude-dir .git | xargs sed -i 's@${localEnv:GITHUB_REPOSITORY}@'"${{ github.repository }}"'@g'
grep -rl '{{gh.repo_name}}' . --exclude-dir .git | xargs sed -i 's/{{gh.repo_name}}/'"${{ github.event.repository.name }}"'/g'
grep -rl '{{gh.org_name}}' . --exclude-dir .git | xargs sed -i 's/{{gh.org_name}}/'"${{ github.repository_owner }}"'/g'
grep -rl '{{gh.repository}}' . --exclude-dir .git | xargs sed -i 's@{{gh.repository}}@'"${{ github.repository }}"'@g'
grep -rl '{{gh.branch}}' . --exclude-dir .git | xargs sed -i 's@{{gh.branch}}@'"${{ steps.find_branch.outputs.branch }}"'@g'
- name: Setup Python3 🐍
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Build MkDocs Site
run: |
pip install mkdocs-material
pip install mkdocs-macros-plugin
pip install mdx_truly_sane_lists
mkdocs build
- name: Build Directories and Copy images 🖼️
run: |
mkdir site/slides \
&& mkdir site/pdfs \
&& cp -R slides/img site/slides/img
- name: Build HTML from Marp 🔨
uses: docker://marpteam/marp-cli:v3.4.0
with:
args: --theme-set ./themes/ --html --input-dir slides/ -o site/slides/
env:
MARP_USER: root:root
- name: Build PDF from marp_slides.md 🔨
uses: docker://marpteam/marp-cli:v3.4.0
with:
args: --theme-set ./themes/ --html --pdf --allow-local-files --input-dir slides/ -o site/pdfs/
env:
MARP_USER: root:root
- name: Add lab archive for local download
run: |
mkdir site/lab_archives
mkdir temp_labs
for DEMO_DIR in demos/*
do
DEMO_NAME="${DEMO_DIR##*/}"
mkdir temp_labs/${DEMO_NAME}
mkdir temp_labs/${DEMO_NAME}/.devcontainer
mkdir temp_labs/${DEMO_NAME}/demos
cp -r .devcontainer/${DEMO_NAME}/* temp_labs/${DEMO_NAME}/.devcontainer/
cp -r demos/${DEMO_NAME}/ temp_labs/${DEMO_NAME}/demos/
tar -czvf site/lab_archives/${DEMO_NAME}.tar.gz temp_labs/${DEMO_NAME}
done
# - name: setup node.js 🏗️
# uses: actions/setup-node@v4
# with:
# node-version: 18
# - name: install gzipper and compress files 🖥️
# run: |
# npm init -y
# npm i gzipper -g
# gzipper compress --include htm,html,css,js,svg,xml,map,json,img,png,jpg,jpeg --zopfli --brotli --remove-larger ./site/
- name: Setup Pages 📖
uses: actions/configure-pages@v5
- name: Upload artifact 🔼
uses: actions/upload-pages-artifact@v3
with:
path: ./site/
- name: Deploy to GitHub Pages 🚀
id: deployment
uses: actions/deploy-pages@v4
# - name: Deploy production 🚀
# if: ${{ github.event_name == 'push' }}
# uses: JamesIves/github-pages-deploy-action@v4
# with:
# branch: gh-pages
# folder: ./site/