Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 733 Bytes

DOCUMENTATION.md

File metadata and controls

41 lines (25 loc) · 733 Bytes

Documentation

About

The documentation roughly attempts to follow Diátaxis.

View

As of today, you can view the moccasin documentation here.

Build

To build the documentation, you can do the following.

  1. Follow the Installing for local development instructions in the CONTRIBUTING.md file.

  2. Add dependencies

uv sync --all-extras
  1. Build the documentation
just docs
  1. Open the documentation in your browser of choice.

If using something like VSCode's live server, open:

http://127.0.0.1:5500/built_docs/html/index.html

Or:

/path/to/your/file/built_docs/html/index.html