{"id":28861109,"url":"https://github.com/aptos-labs/aptos-docs","last_synced_at":"2026-03-15T16:08:55.520Z","repository":{"id":296462303,"uuid":"926153418","full_name":"aptos-labs/aptos-docs","owner":"aptos-labs","description":"Documentation for the Aptos Blockchain","archived":false,"fork":false,"pushed_at":"2026-03-09T04:25:51.000Z","size":20185,"stargazers_count":52,"open_issues_count":27,"forks_count":26,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-09T09:31:46.558Z","etag":null,"topics":["aptos","aptos-move","blockchain","docs","documentation"],"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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-02-02T17:19:59.000Z","updated_at":"2026-03-07T16:38:25.000Z","dependencies_parsed_at":"2025-07-18T19:23:44.129Z","dependency_job_id":"e40d0bb6-eebd-41ee-9c8c-727c5656c086","html_url":"https://github.com/aptos-labs/aptos-docs","commit_stats":null,"previous_names":["aptos-labs/aptos-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/aptos-labs/aptos-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Faptos-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Faptos-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Faptos-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Faptos-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aptos-labs","download_url":"https://codeload.github.com/aptos-labs/aptos-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aptos-labs%2Faptos-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30546678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-15T15:03:43.933Z","status":"ssl_error","status_checked_at":"2026-03-15T15:03:37.630Z","response_time":61,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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","aptos-move","blockchain","docs","documentation"],"created_at":"2025-06-20T05:04:42.164Z","updated_at":"2026-03-15T16:08:55.515Z","avatar_url":"https://github.com/aptos-labs.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# \u003cpicture style=\"float:left; margin-right: 8px;\"\u003e\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"./src/assets/aptos-logomark-dark.svg\"\u003e\u003cimg src=\"./src/assets/aptos-logomark-light.svg\" alt=\"Aptos logo\" width=\"40\" height=\"40\"\u003e\u003c/picture\u003e Aptos Docs\n\nThis repository contains the source code for the official Aptos Developer Documentation, built using [Astro](https://astro.build/) and [Starlight](https://starlight.astro.build/).\n\n## Quick Start\n\n```bash\n# Clone the repository\ngit clone https://github.com/aptos-labs/aptos-docs.git\ncd aptos-docs\n\n# Install dependencies\npnpm install\n\n# Set up environment variables\ncp .env.example .env\n\n# Start the development server\npnpm dev\n```\n\nVisit `http://localhost:4321` to see the documentation running locally.\n\n## Editing Documentation\n\nThe main documentation content is located in the `src/content/docs/` directory:\n\n- Content is organized in directories that match the URL structure\n- Files are written in Markdown MDX (`.mdx`) format\n- Each file begins with frontmatter (metadata between `---` delimiters)\n\nExample frontmatter:\n\n```yaml\n---\ntitle: Your Page Title\ndescription: A brief description of the page content\n---\n```\n\nFor more resources on authoring content within this environment, see:\n\n- [Authoring Content in Markdown](https://starlight.astro.build/guides/authoring-content/)\n- [Using Components](https://starlight.astro.build/components/using-components/)\n\nWith the development server running (`pnpm dev`), your changes will be reflected immediately.\n\n## Prerequisites\n\n- **Node.js:** Version 22.x (specified in `.nvmrc`, use [nvm](https://github.com/nvm-sh/nvm))\n- **pnpm:** Version 10.2.0 or higher (`npm install -g pnpm`)\n- **Git:** For cloning the repository\n\n## Key Features\n\n- Multi-language support\n- Interactive components (GraphiQL editor, Testnet Faucet)\n- API Reference via OpenAPI specifications\n- Move Reference documentation\n- Search functionality (Algolia DocSearch)\n- Dynamic OG Images\n\n## Common Commands\n\n| Command        | Description                   |\n| -------------- | ----------------------------- |\n| `pnpm dev`     | Start the development server  |\n| `pnpm build`   | Build the site for production |\n| `pnpm preview` | Preview the production build  |\n| `pnpm lint`    | Check for linting issues      |\n| `pnpm format`  | Fix formatting issues         |\n\n## Environment Variables\n\nKey environment variables:\n\n| Variable                | Type   | Purpose                        | Required?                            |\n| ----------------------- | ------ | ------------------------------ | ------------------------------------ |\n| `GITHUB_TOKEN`          | Secret | Fetching Move Reference docs   | Only if `ENABLE_MOVE_REFERENCE=true` |\n| `ENABLE_API_REFERENCE`  | Public | Build REST API reference pages | Optional (default: `false`)          |\n| `ENABLE_MOVE_REFERENCE` | Public | Build Move Reference docs      | Optional (default: `false`)          |\n| Firebase Credentials    | Public | Authentication features        | Required for Faucet/Auth             |\n| Algolia Credentials     | Public | Documentation search           | Optional                             |\n| `GTAG_ID`               | Public | Google Analytics tracking      | Optional                             |\n| `OG_IMAGES_SECRET`      | Secret | Dynamic OG image generation    | Recommended for Vercel               |\n\n## Project Structure\n\n```\n.\n├── config/                 # Global sidebar configuration helper\n├── patches/                # Patched npm dependencies\n├── public/                 # Static assets\n├── scripts/                # Utility scripts (Migration \u0026 Middleware generation)\n├── src/\n│   ├── assets/             # Site assets\n│   ├── components/         # Reusable components\n│   ├── config/             # Configuration helpers (i18n, docSearch, sidebar)\n│   ├── content/            # Content Collections\n│   │   ├── docs/           # Main documentation content\n│   │   ├── i18n/           # UI translations\n│   │   └── nav/            # Sidebar translations\n│   ├── integrations/       # Custom integrations\n│   ├── lib/                # Utility functions\n│   ├── loaders/            # Content Collection loaders\n│   ├── middlewares/        # Edge Middleware\n│   ├── pages/              # Astro pages\n│   ├── plugins/            # Remark/Rehype plugins\n│   ├── starlight-overrides/ # Overridden components\n│   ├── stores/             # State management\n│   ├── styles/             # CSS styles\n│   └── utils/              # General utilities\n└── Various config files    # Configuration files\n```\n\n## Configuration Files\n\n| File               | Purpose                                       |\n| ------------------ | --------------------------------------------- |\n| `.env.example`     | Example environment variables                 |\n| `astro.config.mjs` | Main configuration                            |\n| `astro.sidebar.ts` | Documentation sidebar structure               |\n| `package.json`     | Project dependencies and scripts              |\n| `vercel.json`      | Vercel deployment configuration and redirects |\n\n## Redirects\n\nRedirects are handled in `./vercel.json` for optimal performance. This approach ensures redirects are processed at the CDN level before middleware logic runs, providing faster response times for users and less potential for conflicts.\n\nThe `vercel.json` file contains all URL redirects with the following structure:\n\n```json\n{\n  \"redirects\": [\n    {\n      \"source\": \"/old-path\",\n      \"destination\": \"/new-path\",\n      \"permanent\": true\n    }\n  ]\n}\n```\n\n**Benefits of CDN-level redirects:**\n\n- **Performance**: Redirects are handled at the edge, closest to users\n- **Speed**: No server-side processing or middleware execution required\n- **Efficiency**: Bypasses i18n middleware and other application logic\n- **Reliability**: Reduces server load and potential points of failure\n\nWhen adding new redirects, always update the `vercel.json` file rather than implementing them in middleware to maintain optimal performance.\n\nFor more information on configuring redirects, see the [Vercel redirects documentation](https://vercel.com/docs/project-configuration#redirects).\n\n## Technologies Used\n\n| Category            | Technology                                          | Description                                |\n| ------------------- | --------------------------------------------------- | ------------------------------------------ |\n| **Framework**       | [Astro](https://astro.build/)                       | Web framework for content-driven sites     |\n| **Docs Framework**  | [Starlight](https://starlight.astro.build/)         | Documentation toolkit for Astro            |\n| **Styling**         | [Tailwind CSS](https://tailwindcss.com/)            | Utility-first CSS framework                |\n| **UI Components**   | [React](https://react.dev/)                         | UI library (via Astro Islands)             |\n| **Package Manager** | [pnpm](https://pnpm.io/)                            | Fast, disk space efficient package manager |\n| **Search**          | [Algolia DocSearch](https://docsearch.algolia.com/) | Documentation search                       |\n| **Authentication**  | [Firebase](https://firebase.google.com/)            | Auth and backend services                  |\n| **Deployment**      | [Vercel](https://vercel.com/)                       | Hosting platform                           |\n\n## Contributing\n\n- Ensure code adheres to ESLint rules (`pnpm lint`)\n- Format code using Prettier (`pnpm format`)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faptos-labs%2Faptos-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faptos-labs%2Faptos-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faptos-labs%2Faptos-docs/lists"}