Developer Documentation

• Developer Documentation
  • Installation
    • Requirements
  • Clone the Developer docs repo
  • Install deps
  • Develop on Nextra (New)
  • Develop on Docusaurus (Legacy)
  • Debugging
  • Regenerating contributors

Visit the README.md under apps/docusaurus for more steps on building / developing in this repo

We now use lychee-broken-link-checker to check for broken links in the GitHub Markdown. We use a corresponding link checker for pages on Aptos.dev.

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

Installation

IMPORTANT: These installation steps apply to macOS environment.

Requirements

Before you proceed, make sure you install the following tools.

• Install Node.js by executing the below command on your Terminal:

brew install node

• Install the latest pnpm by executing the below command on your Terminal:

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

Clone the Developer docs repo

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

Install deps

You may have to run the following command first if you are on macOS M1 Sonoma or newer

pnpm add node-gyp -g

pnpm install

Develop on Nextra (New)

Note: PLEASE SEE apps/nextra/README.md for more details!

0. Setup environment

Ensure you have configured your .env properly under apps/nextra/.env. There is a .env.example there that you can duplicate and rename to .env for simplicity.

To ensure you have the right setup, you can run

pnpm prebuild

1. Build Nextra

npx turbo run build --filter={apps/nextra}...

This will build apps/nextra and all local packages it depends on.

2. Navigate to the correct subdirectory

cd apps/nextra

3. Run development server

pnpm dev

Develop on Docusaurus (Legacy)

1. Navigate to the correct subdirectory

cd apps/docusaurus

2. Build the repository

pnpm build

3. Navigate to the correct subdirectory

pnpm serve

Debugging

Fix formatting issues by running:

pnpm fmt

Regenerating contributors

The src/contributors.json file (which powers the list of Authors at the bottom of doc pages) needs to be manually generated.

In order to generate the contributor map you must authenticate with GitHub. The best way to do that is using GitHub CLI ([installation guide(https://github.com/cli/cli#installation)]). Once you have the GitHub CLI installed, you can run the following command to authenticate:

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

Once that is done, you can generate the map with this command:

pnpm contributors