Skip to content

Commit

Permalink
add new workflow and config
Browse files Browse the repository at this point in the history
  • Loading branch information
kafitzgerald committed Jul 13, 2024
1 parent 7eac90b commit 2d2d68d
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# This file was created automatically with `myst init --gh-pages` 🪄 💚

name: MyST GitHub Pages Deploy
on:
push:
# Runs on pushes targeting the default branch
branches: [main]
env:
# `BASE_URL` determines the website is served from, including CSS & JS assets
# You may need to change this to `BASE_URL: ''`
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@v4
- name: Setup Pages
uses: actions/configure-pages@v3
- uses: actions/setup-node@v4
with:
node-version: 18.x
- name: Install MyST Markdown
run: npm install -g mystmd
- name: Build HTML Assets
run: myst build --html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: './_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
29 changes: 29 additions & 0 deletions myst.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# See docs at: https://mystmd.org/guide/frontmatter
version: 1
project:
id: e8285412-8d71-4ea9-9e66-75f823ad5818
# title:
# description:
# keywords: []
# authors: []
github: https://github.com/projectpythia-mystmd/eofs-cookbook
# To autogenerate a Table of Contents, run "myst init --write-toc"
toc:
# Auto-generated by `myst init --write-toc`
- file: README.md
- title: Preamble
children:
- file: notebooks/how-to-cite.md
- title: Foundations
children:
- file: notebooks/eof-intro.ipynb
- file: notebooks/climate-modes-xeofs.ipynb
- title: Appendix
children:
- file: references.md

site:
template: book-theme
# options:
# favicon: favicon.ico
# logo: site_logo.png

0 comments on commit 2d2d68d

Please sign in to comment.