GitHub 热门项目：文档

GitHub 项目：文档 仓库地址：https://github.com/inkonchain/docs 星级：36682 | 作者：inkonchain 项目描述：墨水文档 =================================================== 自述文件内容： [](https://x.com/inkonchain) # InkChain 文档应用程序 使用 Next.js 和 Nextra for InkChain 构建的先进、简化的文档平台。 ## ? 构建并运行 1. **构建 Docker 镜像**： ````bash docker build -t 文档。 ```` 2. **运行 Docker 容器**： ````bash docker run -p 3000:3000 文档 ```` ## ? 要求 * **Node.js**：v20.11.0 或更高版本 ## ? 概述 这是一个由 [Nextra](https://nextra.site/) 提供支持并基于 [Next.js](https://nextjs.org/) 构建的文档应用程序。 Nextra 简化了文档站点的创建，使我们能够利用 **Pages Router** 进行高效的导航和路由。目前，由于兼容性限制，我们尚未升级到App Router。 ## ? 开始使用 开始本地开发： 1. **克隆存储库** 2. **安装依赖**： ````bash 即插即用安装 ```` 3. **启动开发服务器**： ````bash pnpm 运行开发 ```` ## ? 工具 我们的开发设置包括多种工具来维护高质量的代码和文档： * **[CSpell](https://cspell.org/)**：实时拼写检查以保持文档准确性。 * **[备注](https://remark.js.org/)**：使用添加的插件处理和渲染 Markdown 内容。 * **[ESLint](https://eslint.org/)**：通过捕获潜在问题来确保代码质量。 * **[Prettier](https://prettier.io/)**：强制执行一致的代码格式。 * **[Tailwind CSS](https://tailwindcss.com/)**：实用程序优先的 CSS 框架，用于快速、响应式 UI 开发。 ## ? CI/CD 管道 我们的 CI/CD 设置利用 GitHub Actions 对每个拉取请求 (PR) 运行自动检查： * **js-lint**：使用 ESLint 确保正确的 JavaScript 代码格式。 * **md-lint**：使用 Remark 检查 Markdown 代码格式。 * **格式**：强制使用 Prettier 一致的代码风格。 * **拼写检查**：使用 CSpell 验证文档中的拼写是否正确。对于任何独特术语（例如“InkChain”），请将其添加到 [`./cspell/project-words.txt`](./cspell/project-words.txt) 文件中以列入白名单。 ## ? 功能分支部署 对于每个新 PR，我们的 CI/CD 管道都会通过 **AWS Amplify** 部署临时环境。这种实时部署可以在合并之前进行实时测试和更改审查，从而确保工作流程更加顺畅。部署 URL 在 PR 检查中自动提供，允许团队成员与新功能进行交互。 ## ? 生产部署 “main”分支配置为通过 **AWS Amplify** 自动持续部署。每次合并都会触发新的构建和部署，确保用户无需手动干预即可使用最新版本的文档。