Skip to content

README.md

Latest commit

 

History

History
65 lines (44 loc) · 1.77 KB

README.md

File metadata and controls

65 lines (44 loc) · 1.77 KB

ber-data.github.io

Source for the BER Data organization landing page, built with MkDocs Material and published to GitHub Pages via GitHub Actions.

Stack

  • uv — Python env + dependency management
  • just — task runner
  • MkDocs Material — site generator
  • GitHub Actions — builds on every push to main and deploys to the gh-pages branch

Requirements

Local development

# install deps into a local virtualenv
just install

# serve with live reload at http://localhost:8000
just serve

# build into ./site (with strict mode)
just build

Run just with no arguments to see all available recipes.

Editing content

All content lives under docs/:

  • docs/index.md — home/landing page
  • docs/projects.md — project cards
  • docs/team.md — team members
  • docs/blog/ — blog posts (new posts go in docs/blog/posts/)

Site configuration lives in mkdocs.yml.

Deployment

Pushing to main triggers .github/workflows/deploy.yml, which builds the site with mkdocs gh-deploy and force-pushes to the gh-pages branch.

One-time setup on GitHub:

  1. Repo Settings → Pages
  2. Set Source to Deploy from a branch
  3. Choose branch gh-pages, folder / (root)

Pull requests run .github/workflows/ci.yml, which builds the site in --strict mode to catch broken links and warnings.

Manual deploy

just deploy