Developer Documentation

• Installation
  • Requirements
• Fork and clone the Aptos repo
• Build and serve the docs locally
• Build static html files
• Debug/Format files

This Aptos Developer Documenatation is built using Docusaurus 2. Follow the below steps to build the docs locally to test your contribution.

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 Aptos repo

git clone https://github.com/aptos-labs/aptos-core.git

Build and serve the docs locally

1. cd into the developer-docs-site directory in your clone.

cd aptos-core/developer-docs-site

2. Run pnpm.

pnpm install

This step will configure the Docusaurus static site generator.

3. Start the server locally. This will also open the locally built docs in your default browser.

NOTE: This step will not generate static html files, but will render the docs dynamically.

pnpm start

(Optional) Build static html files

Execute the below steps if you want to generate static html documentation files. A build directory will be created with the static html files and assets contained in it.

1. Make sure you install dependencies.

pnpm install

2. Build static html files with pnpm.

pnpm build

This command generates static html content and places it in the build directory.

3. Finally, use the below command to start the documentation server on your localhost.

pnpm run serve

Debugging

Fix formatting issues by running:

pnpm fmt

Re-generate contributors

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

pnpm contributors

And then create a PR with the updated src/contributors.json.