Files
feresaria/site
Samuel Onoja 891727ec7a Refresh screenshot galleries and repair portal upgrades
Use the September 30 hero on the website and README, add a shared screenshot gallery, and remove the old showcase images. Build image links locally and clean generated site output.

Back up the known development portal override during installation and report custom overrides before building. Keep source selections clear while letting blur show through unselected rows.
2026-09-30 13:50:06 +01:00
..

Ferese website and handbook

The public site is static HTML and CSS. The handbook is generated from the project's Markdown guides, so website and repository documentation stay in sync.

Local preview

python3 -m venv .site-venv
.site-venv/bin/pip install -r site/requirements.txt
.site-venv/bin/python scripts/build-site.py
python3 -m http.server 8080 --bind 127.0.0.1 --directory build/site

Open http://localhost:8080 or http://localhost:8080/docs/. Rebuild after editing site sources or Markdown guides, then refresh the browser.

  • site/index.html and site/styles.css: homepage and shared visual design.
  • site/content/index.md: handbook introduction.
  • docs/*.md: guides; published pages are listed in scripts/build-site.py.
  • scripts/build-site.py: renders Markdown, resolves links, generates section navigation, previous/next links, and the search index.
  • site/app.js: handbook search and code copying. Reading and navigation work without JavaScript. Search is local to the browser, with no third-party service.

GitHub Pages

Select Settings → Pages → Source → GitHub Actions. The Pages workflow publishes site and documentation changes pushed to main, or can run manually. Expected URL: https://ferese-wm.github.io/ferese/.

Local links are relative, including documentation search, so publishing under the /ferese/ project path works. Screenshots are copied from docs/images during the build; the generated build/site directory is ignored by Git.

See GitHub's custom workflow documentation for deployment setup.