📖 Aptos Developer Documentation

July 23, 2025 · View on GitHub

Documentation has moved to the new aptos-docs repository.

This repository is now archived and will not receive updates.

Aptos Developer Docs

Official Aptos developer documentation, providing everything you need to set up, develop, and test your projects.

📌 Table of Contents

📌 For additional instructions, see the README.md inside apps/nextra/.

Aptos uses lychee-broken-link-checker to verify broken links in Markdown files.

Results can be viewed here:
🔗 GitHub Actions: Link Checking

Before you proceed, ensure you have installed the following dependencies:

pnpm (package manager)
📌 Install the latest version:

curl -fsSL https://get.pnpm.io/install.sh | sh -

git clone https://github.com/aptos-labs/developer-docs.git

📌 If you are using macOS M1 Sonoma or later, first run:

pnpm add node-gyp -g

📌 Then install all dependencies:

pnpm install

⚠ Important: For more details, see apps/nextra/README.md.

📌 Ensure your .env is properly configured inside apps/nextra/.env.
Use .env.example as a template.

📌 Validate the setup:

pnpm prebuild

pnpm run build

📌 This command builds apps/nextra and all dependent local packages.

cd apps/nextra

pnpm run dev

📌 Server will be available at:
🔗 http://localhost:3000

📌 Fix formatting issues by running:

pnpm fmt

📌 The src/contributors.json file (which powers the author list at the bottom of doc pages) needs manual updates.

📌 Install GitHub CLI:
🔗 Installation Guide

📌 Log into your GitHub account:

gh auth login --scopes read:user,user:email

pnpm contributors

📌 The updated list will now appear in the documentation.

This project is licensed under the Apache 2.0.
See LICENSE for more details.

A huge thank you to everyone who has contributed to this project! 🙌