Visit the
README.md
underapps/nextra
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
IMPORTANT: These installation steps apply to MacOS environment.
Before you proceed, make sure you install the following tools.
brew install node
curl -fsSL https://get.pnpm.io/install.sh | sh -
git clone https://github.com/aptos-labs/developer-docs.git
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
Note: PLEASE SEE
apps/nextra/README.md
for more details!
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
npx turbo run build --filter={apps/nextra}...
This will build apps/nextra
and all local packages it depends on.
cd apps/nextra
pnpm dev
Fix formatting issues by running:
pnpm fmt
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