Skip to content

README.md

Latest commit

 

History

History
53 lines (33 loc) · 1.73 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.73 KB

UK EODH Documentation

This repository contains the source for the UK Earth Observation Data Hub (EODH) documentation site, built with MkDocs using the Material for MkDocs theme.

  • Docs source: docs/
  • MkDocs config: mkdocs.yml
  • Published site URL: https://eodatahub.org.uk/docs/documentation

Local development

This repo includes a pixi.toml with the Python dependencies needed to run MkDocs locally.

  1. Install Pixi: pixi.sh
  2. From the repo root:
pixi install
pixi run mkdocs serve

Then open the local URL printed by MkDocs (typically http://127.0.0.1:8000/).

Build the site

To build the static site into site/:

mkdocs build

Deployment

Deployment is handled by GitHub Actions (.github/workflows/ci.yml) on pushes to main/master, using:

mkdocs gh-deploy --force

This publishes the built site.

Writing docs

  • Add/edit pages in docs/ (Markdown and a few Jupyter notebooks).
  • Navigation is configured in mkdocs.yml under nav:.
  • Assets (images, CSS, JS) live under docs/assets/, docs/stylesheets/, and docs/javascripts/.

Style guide (quick)

  • Admonitions: Use MkDocs Material admonitions for callouts (notes, warnings, tips). See Admonitions reference.
  • Icons/emoji: Prefer clean, monochrome Material icons where it helps readability. See Icons + Emoji reference.
  • Consistency: Prefer clean headings, simple lists, and avoid manual line breaks/formatting hacks unless necessary.