{"id":20096065,"url":"https://github.com/aptos-labs/developer-docs","last_synced_at":"2025-05-14T16:13:22.489Z","repository":{"id":211183443,"uuid":"728420303","full_name":"aptos-labs/developer-docs","owner":"aptos-labs","description":"Source for the Aptos developer docs","archived":false,"fork":false,"pushed_at":"2025-04-14T21:40:02.000Z","size":30678,"stargazers_count":995,"open_issues_count":15,"forks_count":139,"subscribers_count":36,"default_branch":"main","last_synced_at":"2025-04-14T22:08:02.457Z","etag":null,"topics":["aptos","blockchain","docs","nextra"],"latest_commit_sha":null,"homepage":"https://aptos.dev","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aptos-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-06T22:47:29.000Z","updated_at":"2025-04-14T21:40:06.000Z","dependencies_parsed_at":"2023-12-20T08:57:58.271Z","dependency_job_id":"0f59a25a-de87-4da7-b5eb-dafbcb0a543b","html_url":"https://github.com/aptos-labs/developer-docs","commit_stats":null,"previous_names":["aptos-labs/developer-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Fdeveloper-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Fdeveloper-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Fdeveloper-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Fdeveloper-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aptos-labs","download_url":"https://codeload.github.com/aptos-labs/developer-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248968914,"owners_count":21191162,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aptos","blockchain","docs","nextra"],"created_at":"2024-11-13T16:57:28.888Z","updated_at":"2025-04-14T22:08:10.538Z","avatar_url":"https://github.com/aptos-labs.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n\u003cp align=\"center\"\u003e\n \u003cimg width=\"100%\" src=\"https://github.com/aptos-labs/aptos-core/raw/main/.assets/aptos_banner.png\" alt=\"Aptos Developer Docs\"\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \n[![Website](https://img.shields.io/badge/Website-Aptos.dev-0077b5?logo=internet-explorer\u0026logoColor=white)](https://aptos.dev)\n[![Docs](https://img.shields.io/badge/Docs-4CAF50?logo=read-the-docs\u0026logoColor=white)](https://aptos.dev/en/build/get-started)\n[![Discord](https://img.shields.io/badge/Join-Discord-5865F2?logo=discord\u0026logoColor=white)](https://discord.com/invite/aptosnetwork)\n[![X (Twitter)](https://img.shields.io/badge/Follow-000000?logo=x\u0026logoColor=white)](https://x.com/aptos)\n[![GitHub Issues](https://img.shields.io/github/issues/aptos-labs/developer-docs?color=yellow\u0026logo=github)](https://github.com/aptos-labs/developer-docs/issues)\n\nWith results visible at:\n[https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml](https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml)\n\u003c/div\u003e\n\n---\n\n# 📖 **Aptos Developer Documentation**\n\n\u003e Official **Aptos developer documentation**, providing everything you need to set up, develop, and test your projects.\n\n## 📌 **Table of Contents**\n- [💻 Installation](#installation)\n  - [⚙️ Requirements](#requirements)\n- [📂 Clone the Repository](#clone-the-repository)\n- [📦 Install Dependencies](#install-dependencies)\n- [🚀 Develop on Nextra](#develop-on-nextra)\n- [🐞 Debugging](#debugging)\n- [🔄 Regenerating Contributors](#regenerating-contributors)\n\n\u003e 📌 **For additional instructions**, see the `README.md` inside `apps/nextra/`.\n\nAptos uses [lychee-broken-link-checker](https://github.com/marketplace/actions/lychee-broken-link-checker) to verify broken links in Markdown files.  \n\nResults can be viewed here:  \n🔗 [GitHub Actions: Link Checking](https://github.com/aptos-labs/developer-docs/actions/workflows/links.yml)\n\n---\n\n## 💻 **Installation**\n\n### ⚙️ **Requirements**\nBefore you proceed, ensure you have installed the following dependencies:\n\n- **Node.js**  \n  📌 Install via Homebrew:\n  ```sh\n  brew install node\n  ```\n\n- **pnpm (package manager)**  \n  📌 Install the latest version:\n  ```sh\n  curl -fsSL https://get.pnpm.io/install.sh | sh -\n  ```\n\n---\n\n## 📂 **Clone the Repository**\n```sh\ngit clone https://github.com/aptos-labs/developer-docs.git\n```\n\n---\n\n## 📦 **Install Dependencies**\n📌 If you are using **macOS M1 Sonoma or later**, first run:\n```sh\npnpm add node-gyp -g\n```\n\n📌 Then install all dependencies:\n```sh\npnpm install\n```\n\n---\n\n## 🚀 **Develop on Nextra**\n\u003e ⚠ **Important**: For more details, see `apps/nextra/README.md`.\n\n### 1️⃣ **Set up the environment**\n📌 Ensure your `.env` is properly configured inside `apps/nextra/.env`.  \nUse `.env.example` as a template.\n\n📌 Validate the setup:\n```sh\npnpm prebuild\n```\n\n### 2️⃣ **Build Nextra**\n```bash\npnpm run build\n```\n📌 This command builds `apps/nextra` and all dependent local packages.\n\n### 3️⃣ **Navigate to the subdirectory**\n```sh\ncd apps/nextra\n```\n\n### 4️⃣ **Run the local development server**\n```sh\npnpm run dev\n```\n📌 Server will be available at:  \n🔗 **[http://localhost:3000](http://localhost:3000)**\n\n---\n\n## 🐞 **Debugging**\n📌 Fix formatting issues by running:\n```sh\npnpm fmt\n```\n\n---\n\n## 🔄 **Regenerating Contributors**\n📌 The `src/contributors.json` file (which powers the author list at the bottom of doc pages) needs manual updates.\n\n### 1️⃣ **Authenticate with GitHub**\n📌 Install **GitHub CLI**:  \n🔗 [Installation Guide](https://github.com/cli/cli#installation)\n\n📌 Log into your GitHub account:\n```sh\ngh auth login --scopes read:user,user:email\n```\n\n### 2️⃣ **Generate the contributor list**\n```sh\npnpm contributors\n```\n📌 The updated list will now appear in the documentation.\n\n---\n\n## 🔗 **Useful Links**\n[![Website](https://img.shields.io/badge/Website-Aptos.dev-0077b5?logo=internet-explorer\u0026logoColor=white\u0026style=for-the-badge)](https://aptos.dev)\n[![Docs](https://img.shields.io/badge/Docs-4CAF50?logo=read-the-docs\u0026logoColor=white\u0026style=for-the-badge)](https://aptos.dev/en/build/get-started)\n[![Discord](https://img.shields.io/badge/Join-Discord-5865F2?logo=discord\u0026logoColor=white\u0026style=for-the-badge)](https://discord.com/invite/aptosnetwork)\n[![X (Twitter)](https://img.shields.io/badge/Follow-000000?logo=x\u0026logoColor=white\u0026style=for-the-badge)](https://x.com/aptos)\n[![GitHub Discussions](https://img.shields.io/badge/GitHub-Discussions-181717?logo=github\u0026logoColor=white\u0026style=for-the-badge)](https://github.com/aptos-labs/developer-docs/discussions)\n\n\n---\n\n## 📜 **License**\nThis project is licensed under the **Apache 2.0**.  \nSee [`LICENSE`](LICENSE) for more details.\n\n---\n\n## 🤝 **Contributors**\nA huge thank you to everyone who has contributed to this project! 🙌  \n\n\u003ca href=\"https://github.com/aptos-labs/developer-docs/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=aptos-labs/developer-docs\" /\u003e\n\u003c/a\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faptos-labs%2Fdeveloper-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faptos-labs%2Fdeveloper-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faptos-labs%2Fdeveloper-docs/lists"}