Skip to content

Update README.md

Update README.md #16

Workflow file for this run

name: MyST GitHub Pages Deploy
on:
push:
# Runs on pushes targeting the default branch
branches: [main]
env:
BASE_URL: /${{ github.event.repository.name }}
# 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:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
- uses: actions/setup-node@v3
with:
node-version: 18.x
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install texlive-xetex latexmk libpng-dev libjpeg-dev libtiff-dev imagemagick -y
- name: Install MyST Markdown
run: npm install -g mystmd
- name: Manually download docx template
run: |
cd manuscript
wget https://github.com/myst-templates/docx_default/archive/refs/heads/main.zip
mkdir -p _build/templates/docx/myst/default
unzip main.zip -d _build/templates/docx/myst/default
cp _build/templates/docx/myst/default/docx_default-main/styles.xml _build/templates/docx/myst/default/styles.xml
- name: Build HTML Assets
run: |
cd manuscript
myst build --docx
myst build --pdf
myst build --html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: './manuscript/_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2