https://github.com/gregnazario/aptos-book
The Aptos Book - A one stop reference for Aptos
https://github.com/gregnazario/aptos-book
aptos aptos-move documentation move
Last synced: 4 months ago
JSON representation
The Aptos Book - A one stop reference for Aptos
- Host: GitHub
- URL: https://github.com/gregnazario/aptos-book
- Owner: gregnazario
- License: apache-2.0
- Created: 2025-04-12T22:19:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-04T13:18:30.000Z (about 1 year ago)
- Last Synced: 2025-05-04T14:19:22.414Z (about 1 year ago)
- Topics: aptos, aptos-move, documentation, move
- Homepage: https://gregnazario.github.io/aptos-book/
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Aptos Book
The Aptos Book - A one-stop reference for Aptos.
## Setup
### Option 1: Using Mise (recommended)
This project uses [Mise](https://mise.jdx.dev/) to manage development tools and dependencies.
1. Install [Mise](https://mise.jdx.dev/getting-started.html).
2. Run the setup script:
```bash
./scripts/setup-mise.sh
```
3. Build, serve, or clean the book with Mise:
```bash
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](https://rustup.rs/).
2. Run the setup script:
```bash
./scripts/setup.sh
```
3. Use mdBook commands directly:
```bash
mdbook build
mdbook serve
mdbook watch
mdbook clean
```