OSC-EM Documentation

This repository contains the source for the OSC-EM documentation website, built with MkDocs and deployed to https://osc-em.github.io.

Local Development

Prerequisites

• Python 3.x
• pip3

Installation

pip3 install -r requirements.txt

Running Locally

mkdocs serve

or, if installed the requirements in a venv:

source venv/bin/activate && mkdocs serve

Then visit http://127.0.0.1:8000 in your browser.

Building the Site

mkdocs build

Deployment

The site is automatically deployed to GitHub Pages when changes are pushed to the main branch via GitHub Actions.

Notes: This repository is a user/organization site (osc-em.github.io). For these repos, GitHub would otherwise serve the README from the default branch if no build step is used. Our workflow uses the official GitHub Pages actions to build MkDocs and publish the generated site/ as the website. Make sure that repository Settings > Pages > "Build and deployment" is set to "GitHub Actions".