Documentation has moved to the new aptos-docs repository.

This repository is now archived and will not receive updates.

With results visible at: https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml

---

📖 Aptos Developer Documentation

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

📌 Table of Contents

• 💻 Installation
  • ⚙️ Requirements
• 📂 Clone the Repository
• 📦 Install Dependencies
• 🚀 Develop on Nextra
• 🐞 Debugging
• 🔄 Regenerating Contributors

📌 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

---

💻 Installation

⚙️ Requirements

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

• Node.js
  📌 Install via Homebrew:

  brew install node

• pnpm (package manager)
  📌 Install the latest version:

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

---

📂 Clone the Repository

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

---

📦 Install Dependencies

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

pnpm add node-gyp -g

📌 Then install all dependencies:

pnpm install

---

🚀 Develop on Nextra

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

1️⃣ Set up the environment

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

📌 Validate the setup:

pnpm prebuild

2️⃣ Build Nextra

pnpm run build

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

3️⃣ Navigate to the subdirectory

cd apps/nextra

4️⃣ Run the local development server

pnpm run dev

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

---

🐞 Debugging

📌 Fix formatting issues by running:

pnpm fmt

---

🔄 Regenerating Contributors

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

1️⃣ Authenticate with GitHub

📌 Install GitHub CLI:
🔗 Installation Guide

📌 Log into your GitHub account:

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

2️⃣ Generate the contributor list

pnpm contributors

📌 The updated list will now appear in the documentation.

---

🔗 Useful Links

---

📜 License

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

---

🤝 Contributors

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