From 7b6f49cd3d54738f4f07c146a8c2f5f2723beaaa Mon Sep 17 00:00:00 2001 From: Angus Hollands Date: Wed, 30 Oct 2024 17:33:45 +0000 Subject: [PATCH] wip: initial commit --- .github/workflows/deploy.yml | 46 ++++++++++++++++++++++++++++++++++++ index.md | 1 + myst.yml | 32 +++++++++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 .github/workflows/deploy.yml create mode 100644 index.md create mode 100644 myst.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..86470e6 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -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@v3 + with: + path: './_build/html' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/index.md b/index.md new file mode 100644 index 0000000..8b013d6 --- /dev/null +++ b/index.md @@ -0,0 +1 @@ +# Index diff --git a/myst.yml b/myst.yml new file mode 100644 index 0000000..4825751 --- /dev/null +++ b/myst.yml @@ -0,0 +1,32 @@ +# See docs at: https://mystmd.org/guide/frontmatter +version: 1 +project: + title: 'Jupyter Book: Blog' + description: Team compass and documentation about governance for the Jupyter Book and MyST Markdown communities. + keywords: + - Jupyter + - JupyterBook + - MyST Markdown + github: https://github.com/jupyter-book/blog + # To autogenerate a Table of Contents, run "myst init --write-toc" + license: CC0-1.0 + toc: + - file: index.md + - file: team.md + - file: governance.md + - file: tips.md + - file: contribute.md + - file: code-of-conduct.md +site: + template: book-theme + nav: [] + actions: + - title: Jupyter Book + url: https://jupyterbook.org + - title: MyST Markdown + url: https://mystmd.org + options: + favicon: images/favicon.png + logo: images/logo-wide.svg + logo_dark: images/logo-wide-dark.svg + logo_text: Team Compass