Visit the
README.mdunderapps/nextrafor 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.
- 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 -git clone https://github.com/aptos-labs/developer-docs.gitYou may have to run the following command first if you are on macOS M1 Sonoma or newer
pnpm add node-gyp -gpnpm installNote: PLEASE SEE
apps/nextra/README.mdfor more details!
- 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- Build Nextra
npx turbo run build --filter={apps/nextra}...This will build apps/nextra and all local packages it depends on.
- Navigate to the correct subdirectory
cd apps/nextra- Run the development server
pnpm devFix formatting issues by running:
pnpm fmtThe 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:emailOnce that is done, you can generate the map with this command:
pnpm contributors