This repository contains the code that documents the CAPIO middleware, built with Material for MkDocs.
pip install -r requirements.txtThis installs Material for MkDocs (which pulls in MkDocs itself).
mkdocs serve # live-reload preview at http://127.0.0.1:8000The page reloads automatically as you save your Markdown.
- Landing page —
content/index.md. Text and buttons are plain Markdown; the showcase / partners / team blocks are Material grid cards; the integrations are Material content tabs. To add a team member, copy a card block in the## Teamsection and update the photo, name, role and link. Drop new images intocontent/assets/images/. Hero / avatar / partner styling lives incontent/stylesheets/extra.css. - Documentation — add/edit Markdown under
content/docs/. To add a page to the sidebar, also add it to thenav:section ofmkdocs.yml.
mkdocs build --strict--strict fails the build on broken links. The output goes to site/, which
contains the landing page (/), the documentation (/docs/) and the schema
(/schema/) all together.
Pushing to main triggers .github/workflows/deploy.yml, which installs the
dependencies, runs mkdocs build --strict, and uploads the single site/
folder to the web root of capio.hpc4ai.it.