README.md

granite-io API Documentation with MKDocs

This directory contains the documentation site for the granite-io project, built using MkDocs and the Material for MkDocs theme.

What is this?

• This is the source for the granite-io documentation site.
• Documentation is written in Markdown and lives in the docs/ subdirectory.
• The site is built and served using MkDocs, a static site generator for project documentation.

How to Use MkDocs

1. Install MkDocs and the Material theme

You can install MkDocs and the Material theme using pip:

pip install mkdocs mkdocs-material

2. Serve the Documentation Locally

From the mkdocs/ directory, run:

mkdocs serve

This will start a local development server (usually at http://127.0.0.1:8000/) with live reloading as you edit Markdown files.

3. Build the Documentation Site

To build the static site (output in the site/ directory):

mkdocs build

4. Directory Structure

• mkdocs.yml — MkDocs configuration file
• docs/ — Markdown documentation pages
• site — Output directory for the built site (only appears after running mkdocs build)
• docs/img - Image storage IBM Logos(s) subject to copyright

More Information

• See MkDocs documentation for advanced usage and deployment options.