Skip to content

Euro-Office/documentation

Repository files navigation

Euro-Office Documentation

Source for the Euro-Office documentation site, built with MkDocs and the Material theme.

Build locally

The fastest path is the Makefile, which bootstraps a .venv on first use:

make serve               # live preview at http://127.0.0.1:8000
make build               # production build into ./site (strict)

If you prefer not to use make:

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

mkdocs serve
mkdocs build --strict

--strict is what CI runs — it fails on broken links, missing pages, and unused config keys.

Authoring guidelines

  • Never hard-code "Euro-Office", use {{ brand.name }} so rebranders inherit the change automatically.
  • Internal component names (DocService, FileConverter, sdkjs) are product-internal and stay literal.
  • Prefer Material's admonitions, content tabs, and code annotations over plain prose where they aid scanning.

About

No description, website, or topics provided.

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors