Skip to content

gregnazario/aptos-book

Repository files navigation

Aptos Book

The Aptos Book - A one-stop reference for Aptos.

Setup

Option 1: Using Mise (recommended)

This project uses Mise to manage development tools and dependencies.

  1. Install Mise.
  2. Run the setup script:
    ./scripts/setup-mise.sh
  3. Build, serve, or clean the book with Mise:
    mise run build    # Build the book
    mise run serve    # Serve the book locally
    mise run watch    # Watch for changes and rebuild
    mise run clean    # Clean build artifacts

Option 2: Traditional setup

  1. Install Rust.
  2. Run the setup script:
    ./scripts/setup.sh
  3. Use mdBook commands directly:
    mdbook build
    mdbook serve
    mdbook watch
    mdbook clean

Contributors