KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

documentation

★ 42 Open GitHub ↗

Documentation for Euro-Office

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Euro-Office Documentation

Our documentation is automatically deployed at https://euro-office.github.io/documentation/

Source for the Euro-Office documentation site, built with
[MkDocs](https://www.mkdocs.org/) and the
[Material](https://squidfunk.github.io/mkdocs-material/) theme.

## Build locally

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

```bash
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`:

```bash
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](https://squidfunk.github.io/mkdocs-material/reference/admonitions/),
  [content tabs](https://squidfunk.github.io/mkdocs-material/reference/content-tabs/),
  and [code annotations](https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#adding-annotations)
  over plain prose where they aid scanning.

documentation

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README