Documentation

TEAMMATES uses MarkBind to build the developer documentation site.

Installation

Run npm ci to install MarkBind and other dependencies.

Previewing Locally

npm run serve

    

    Copy
    

    


    
    
    

The site will be available at http://localhost:8080 and updates automatically as you make changes. To use a different port:

npm run serve -- -p 8090

    

    Copy
    

    


    
    
    

Writing Documentation

MarkBind pages work like standard Markdown with a few additions:

• Front matter: Add a <frontmatter> block at the top of each page to set the page title:

<frontmatter>
  title: "YOUR TITLE HERE"
</frontmatter>

    

    Copy
    

    


    
    
    

• Navigation: To add a new page to the sidebar, include it in _markbind/layouts/default.md.
• MarkBind features: You can use panels, PUML diagrams, content reuse, and additional formatting.

Refer to the MarkBind user guide for full documentation.

Deployment

Documentation is automatically deployed to GitHub Pages on every push to master, as configured in .github/workflows/dev-docs.yml.