Ferese website and handbook
The website's handbook is built from the project's Markdown guides, so the website and repository share the same documentation.
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 for the homepage or http://localhost:8080/docs/ for the handbook. Rebuild and refresh the browser after changing the site sources or guides.
site/index.htmlandsite/styles.css: homepage and shared visual design.site/content/index.md: handbook introduction.docs/*.md: guides; published pages are listed inscripts/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
Choose Settings → Pages → Source → GitHub Actions to publish through the Pages
workflow. It runs when site or documentation changes reach main; you can also
start it manually. The expected address is https://ferese-wm.github.io/ferese/.
The site uses relative links, including for handbook search, so it also works under the
/ferese/ project path. Each build copies screenshots from docs/images into
build/site, which is ignored by Git.
For deployment setup, follow GitHub’s custom workflow documentation.