Skip to content

High-Performance-IO/CAPIO-website

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CAPIO website

This repository contains the code that documents the CAPIO middleware, built with Material for MkDocs.

Requirements

pip install -r requirements.txt

This installs Material for MkDocs (which pulls in MkDocs itself).

Edit & preview locally

mkdocs serve     # live-reload preview at http://127.0.0.1:8000

The page reloads automatically as you save your Markdown.

  • Landing pagecontent/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 ## Team section and update the photo, name, role and link. Drop new images into content/assets/images/. Hero / avatar / partner styling lives in content/stylesheets/extra.css.
  • Documentation — add/edit Markdown under content/docs/. To add a page to the sidebar, also add it to the nav: section of mkdocs.yml.

Build

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.

Deployment

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.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors