Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: about 12 hours 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 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-18T12:20:48.000Z (2 days ago)
- Last Synced: 2025-01-20T01:08:11.127Z (about 16 hours ago)
- Topics: aptos, blockchain, docs, nextra
- Language: MDX
- Homepage: https://aptos.dev
- Size: 27.3 MB
- Stars: 923
- Watchers: 34
- Forks: 115
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Developer Documentation
- [Developer Documentation](#developer-documentation)
- [Installation](#installation)
- [Requirements](#requirements)
- [Clone the Developer docs repo](#clone-the-developer-docs-repo)
- [Install deps](#install-deps)
- [Develop on Nextra (New)](#develop-on-nextra-new)
- [Debugging](#debugging)
- [Regenerating contributors](#regenerating-contributors)
> Visit the `README.md` under `apps/nextra` for more steps on building / developing in this repo
We now use [lychee-broken-link-checker](https://github.com/marketplace/actions/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](https://nodejs.org/en/download/) by executing the below command on your Terminal:
```sh
brew install node
```
- Install the latest [pnpm](https://pnpm.io/installation) by executing the below command on your Terminal:
```sh
curl -fsSL https://get.pnpm.io/install.sh | sh -
```
## Clone the Developer docs repo
```sh
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
```sh
pnpm add node-gyp -g
```
```sh
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
```sh
pnpm prebuild
```
1. Build Nextra
```bash
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
```sh
cd apps/nextra
```
3. Run the development server
```sh
pnpm dev
```
## Debugging
Fix formatting issues by running:
```sh
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:
```sh
gh auth login --scopes read:user,user:email
```
Once that is done, you can generate the map with this command:
```sh
pnpm contributors
```