Skip to content

taubyte/tau.how

Repository files navigation

Taubyte Documentation

This is the documentation site for Taubyte, built with MkDocs Material.

Local Development

Setup

  1. Install dependencies:
pip install -r requirements.txt
  1. Serve locally:
mkdocs serve
  1. Build the site:
mkdocs build

Deployment

This site is automatically deployed to GitHub Pages using GitHub Actions when changes are pushed to the main branch.

Manual Deployment (if needed)

If you need to manually deploy:

mkdocs gh-deploy

Repository Structure

.
├── .github/
│   └── workflows/       # GitHub Actions workflows
├── docs/                # Documentation source files
├── site/                # Built site (generated, gitignored)
├── mkdocs.yml          # MkDocs configuration
└── requirements.txt    # Python dependencies

Documentation

About

Taubyte documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published