Merge pull request #2 from openmc-dev/change-to-myst

rewritten in myst

Author: shimwell

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+# This file was created automatically with `myst init --gh-pages` 🪄 💚
+# Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**.
+
+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
+  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

.gitignore

@@ -0,0 +1 @@
+_build

README.md

@@ -1,12 +1,15 @@
 
-A repo showing how to make the OpenMC website using Github pages.
 
-The website makes use of the [Slate](https://github.com/pages-themes/slate) GitHub pages theme as this is the most similar to the current openmc.org style.
+A repository containing the OpenMC website using Github pages.
 
-There are [other themes](https://pages.github.com/themes/) and of course themes can be altered to suit.
+To build the site locally, clone the repository then install Myst Markdown
 
-The site is simple to maintain as it is just a few pages written in MarkDown (which Jekyll  converts to html when Github pages builds the site)
+```
+python -m pip install mystmd
+```
+Then build and host the site locally with
+```
+myst start
+```
 
-Moving the website to a github repo (which could be part of the openmc-dev organisation) allows contributors to help maintain the site. Github pages also support custom domains so it could in theory do everything we need.
-
-[link to demo site](https://opnmc-dev.github.io/openmc.org/)
+[link to live site](https://opnmc-dev.github.io/openmc.org/)

_config.yml

@@ -3,8 +3,6 @@ layout: default
 title: OpenMC
 description: OpenMC Monte Carlo Code
 ---
-
-| [Documentation](https://docs.openmc.org/) | [Discussion Forum](https://openmc.discourse.group/) | [Cross Sections](./cross_sections.html) | [Depletion Chains](./depletion_chains.html) |
         
 
 OpenMC is a community-developed Monte Carlo neutron and photon transport code. It is capable of performing fixed source, k-eigenvalue, and subcritical multiplication calculations on models built using either a constructive solid geometry or CAD representation. A flexible and efficient tally system enables a wide variety of physical quantities to be tallied and analyzed. OpenMC can run in parallel using a hybrid MPI and OpenMP programming model and has been extensively tested on leadership class supercomputers.

index.md

@@ -0,0 +1,27 @@
+version: 1
+project:
+  toc:
+  - file: index.md
+  - file: cross_sections.md
+  - file: depletion_chains.md
+  title: OpenMC
+  keywords: []
+  authors: []
+site:
+  template: book-theme
+  title: OpenMC
+  options:
+    logo: logo.png
+    favicon: favicon.ico
+    hide_toc: true
+    hide_footer_links : true
+  nav:
+  - title: Documentation
+    url: https://docs.openmc.org/
+  - title: Discussion Forum
+    url: https://openmc.discourse.group/
+  - title: Cross Sections
+    url: /openmc.org/cross_sections
+  - title: Depletion Chains
+    url: /openmc.org/depletion_chains
+  domains: []