https://github.com/aptos-labs/developer-docs
Source for the Aptos developer docs
https://github.com/aptos-labs/developer-docs
aptos blockchain docs nextra
Last synced: 7 months ago
JSON representation
Source for the Aptos developer docs
- Host: GitHub
- URL: https://github.com/aptos-labs/developer-docs
- Owner: aptos-labs
- License: apache-2.0
- Created: 2023-12-06T22:47:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-14T21:40:02.000Z (8 months ago)
- Last Synced: 2025-04-14T22:08:02.457Z (8 months ago)
- Topics: aptos, blockchain, docs, nextra
- Language: MDX
- Homepage: https://aptos.dev
- Size: 29.3 MB
- Stars: 995
- Watchers: 36
- Forks: 139
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
[](https://aptos.dev)
[](https://aptos.dev/en/build/get-started)
[](https://discord.com/invite/aptosnetwork)
[](https://x.com/aptos)
[](https://github.com/aptos-labs/developer-docs/issues)
With results visible at:
[https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml](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](#installation)
- [⚙️ Requirements](#requirements)
- [📂 Clone the Repository](#clone-the-repository)
- [📦 Install Dependencies](#install-dependencies)
- [🚀 Develop on Nextra](#develop-on-nextra)
- [🐞 Debugging](#debugging)
- [🔄 Regenerating Contributors](#regenerating-contributors)
> 📌 **For additional instructions**, see the `README.md` inside `apps/nextra/`.
Aptos uses [lychee-broken-link-checker](https://github.com/marketplace/actions/lychee-broken-link-checker) to verify broken links in Markdown files.
Results can be viewed here:
🔗 [GitHub Actions: Link Checking](https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml)
---
## 💻 **Installation**
### ⚙️ **Requirements**
Before you proceed, ensure you have installed the following dependencies:
- **Node.js**
📌 Install via Homebrew:
```sh
brew install node
```
- **pnpm (package manager)**
📌 Install the latest version:
```sh
curl -fsSL https://get.pnpm.io/install.sh | sh -
```
---
## 📂 **Clone the Repository**
```sh
git clone https://github.com/aptos-labs/developer-docs.git
```
---
## 📦 **Install Dependencies**
📌 If you are using **macOS M1 Sonoma or later**, first run:
```sh
pnpm add node-gyp -g
```
📌 Then install all dependencies:
```sh
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:
```sh
pnpm prebuild
```
### 2️⃣ **Build Nextra**
```bash
pnpm run build
```
📌 This command builds `apps/nextra` and all dependent local packages.
### 3️⃣ **Navigate to the subdirectory**
```sh
cd apps/nextra
```
### 4️⃣ **Run the local development server**
```sh
pnpm run dev
```
📌 Server will be available at:
🔗 **[http://localhost:3000](http://localhost:3000)**
---
## 🐞 **Debugging**
📌 Fix formatting issues by running:
```sh
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](https://github.com/cli/cli#installation)
📌 Log into your GitHub account:
```sh
gh auth login --scopes read:user,user:email
```
### 2️⃣ **Generate the contributor list**
```sh
pnpm contributors
```
📌 The updated list will now appear in the documentation.
---
## 🔗 **Useful Links**
[](https://aptos.dev)
[](https://aptos.dev/en/build/get-started)
[](https://discord.com/invite/aptosnetwork)
[](https://x.com/aptos)
[](https://github.com/aptos-labs/developer-docs/discussions)
---
## 📜 **License**
This project is licensed under the **Apache 2.0**.
See [`LICENSE`](LICENSE) for more details.
---
## 🤝 **Contributors**
A huge thank you to everyone who has contributed to this project! 🙌
