后端【免费下载链接】fesodFast. Easy. Done. Processing spreadsheets without worrying about large files causing OOM.项目地址https://gitcode.com/gh_mirrors/fast/fesod点击查看免费下载Apache FesodIncubating的官方网站基于 Docusaurus 构建全部文档维护在仓库的website目录中。本文以官方《文档贡献指南》为主体完整讲解从环境准备、目录结构、编写规范到本地预览、静态构建与格式校验的文档贡献全流程并结合仓库中的package.json、docusaurus.config.js、.markdownlint-cli2.jsonc等实际配置给出可验证的依据帮助你提交一份格式合格、可直接合并的文档改动。文档贡献的整体流程官方网站采用 Docusaurus 目录中。无论你修改的是历史版本还是最新版本的文档所有改动都必须通过向apache/fesod仓库提交 Pull RequestPR的方式合入而不是直接修改线上站点。完整的提交流程分为三步修改文档在website目录下按照本文档的编写规范进行内容修改本地验证使用pnpm启动本地预览服务器并通过pnpm md-lint通过格式校验提交 PR遵循提交规范创建拉取请求等待社区提交者审查。提交 PR 的具体操作方法请参阅同目录下的两份配套指南代码贡献指南覆盖 Fork 仓库、克隆、设置 upstream、创建分支、提交与新建 PR 的完整 Git 流程Commit 格式规范规定 Commit Message 的书写格式PR 标题与描述均需遵循。环境要求贡献文档需要在本地搭建 Node.js 运行环境官方要求如下Node.js 版本 24.0 或更高可通过运行node -v命令检查当前版本推荐使用 nvm 在同一台机器上管理多个 Node 版本避免版本切换带来的环境冲突安装 Node.js 时建议勾选所有与依赖项相关的复选框确保npm/pnpm等工具链可用。这一要求与仓库配置完全一致website/package.json中的engines字段明确声明node: 24.0packageManager指定为pnpm11.8.0也就是说文档站的包管理与依赖安装统一使用 pnpm 完成。仓库目录结构文档写在哪里国际化I18n目录结构Docusaurus 原生支持国际化。Fesod 官网目前启用了en英文默认与zh-cn简体中文两种语言这一点可以在 docusaurus.config.js 的i18n配置中确认。需要维护的主要目录结构如下. ├── community # 社区文档英文 ├── docs # 用户文档英文 └── i18n # 国际化 └── zh-cn ├── docusaurus-plugin-content-docs │ └── current # 用户文档简体中文 └── docusaurus-plugin-content-docs-community └── current # 社区文档简体中文其中docusaurus-plugin-content-docs对应主文档Docsdocusaurus-plugin-content-docs-community对应社区文档Community。两条文档线分别由 sidebars.js 和 sidebarsCommunity.js 定义侧边栏结构与导航顺序新增文档文件后需要留意侧边栏配置是否同步更新。单语言文档目录结构在单一语言内部文档按功能主题组织为若干分类。官方指南给出的通用结构如下. ├── quickstart # 1. 快速开始 ├── read # 2. 读取文件 ├── write # 3. 写入 ├── fill # 4. 填充 ├── community # 5. 社区 └── help # 6. FAQ对照当前仓库的实际布局这一结构体现在 website/docs 下的子目录中quickstart/快速开始包含 guide.md 与 example.mdsheet/read/读取文件主题simple、pojo、converter、csv、extra 等sheet/write/写入主题simple、style、merge、image、csv 等sheet/fill/模板填充主题sheet/advanced/进阶主题password、custom-converter、large-filesheet/help/FAQ 与参数说明等帮助文档migration/迁移指南如从 FastExcel 迁移顶层还有 introduce.md 与 download.md。社区文档则集中在 website/community 下覆盖 contribution、committer、pmc、release 等板块与sidebarsCommunity.js的配置一一对应。文档编写规范链接与路径写法编写 Markdown 文档时仓库要求遵循两条硬性路径规范使用带有.md扩展名的文件路径例如[Example](https://link.gitcode.com/i/c1a6a93797cb1a599cfbb0d94e3ec8bb)使用相对于docs/目录的路径而不是相对于当前文件自身所在位置的局部相对路径。这样无论文档位于哪个层级链接都能稳定解析到目标文件。例如从快速开始文档引用快速示例[Example](https://link.gitcode.com/i/c1a6a93797cb1a599cfbb0d94e3ec8bb)在仓库中以根目录为起点表达时对应的真实写法是[快速示例](https://link.gitcode.com/i/c1a6a93797cb1a599cfbb0d94e3ec8bb)。写链接时务必确认目标文件真实存在避免产生 404 死链。图片引用规范图片资源统一存放在static/img目录website/static/img并按用途分子目录维护如blog/博客配图、docs/文档配图、index/首页配图等。文档中引用图片时使用以/img/开头的相对目录形式而不是相对路径或本地文件名例如img仓库中真实存在的一个可参考示例是 sample-image.svg在写入主题文档中即通过/img/docs/write/sample-image.svg的形式引用。新增图片时请先将其放入static/img对应子目录再在文档中编写上述格式的引用。本地预览所有预览与构建命令都需要在website目录下执行。安装依赖pnpm install该命令依据 package.json 安装全部依赖包括docusaurus/core、docusaurus/preset-classic、markdownlint-cli2等。启动本地开发服务器# 英文版 pnpm start # 简体中文版 pnpm start --locale zh-cnpnpm start实际执行docusaurus start会启动一个本地开发服务器并自动打开浏览器窗口。大多数修改Markdown 内容、配置、样式都能实时热更新预览无需重启服务器。注意每次只能运行一种语言版本切换语言前需先停止当前进程。仓库中还提供了等价的独立脚本pnpm start-en即docusaurus start --locale en与pnpm start-zh-cn即docusaurus start --locale zh-cn可在 package.json 中看到完整的脚本定义。生成静态文件可选本地预览无误后可生成用于部署的静态站点pnpm build该命令执行docusaurus build将静态内容生成到website/build目录中随后可以使用任意静态内容托管服务进行部署。此外package.json还提供了pnpm servedocusaurus serve用于本地模拟生产环境访问构建产物以及pnpm cleardocusaurus clear用于清理缓存。文档格式校验Fesod 官网使用 markdownlint-cli2 作为 Markdown 格式检查工具。编写完文档后在本地执行以下命令即可预先检查格式是否符合要求cd website pnpm md-lint # 如果文档存在格式错误可以使用以下命令尝试自动修复。 pnpm md-lint-fix校验脚本与配置的源码依据脚本定义pnpm md-lint对应 package.json 中的md-lint: markdownlint-cli2 --config ./.markdownlint-cli2.jsonc \./**/*.md\ \#node_modules\即使用项目内的配置文件扫描website下所有 Markdown 文件并排除node_modulespnpm md-lint-fix则在此基础上追加--fix参数自动修复规则配置格式规则集中在 website/.markdownlint-cli2.jsonc其中关键配置包括globs限定检查范围为website/**/*.mdMD013将行长度限制放宽到 600 字符且不检查代码块与表格内部方便容纳长代码示例MD024仅在相邻标题siblings之间去重允许不同小节使用相同的标题文本MD033通过allowed_elements白名单放行div、table、img、mark等元素ignores排除了node_modules、target、dist目录其余未显式覆盖的规则采用 markdownlint 的default配置即MD001标题层级递增、MD003标题风格、MD029有序列表序号、MD040代码块语言标注、MD045图片 alt 文本、MD047文件末尾换行等均为默认开启。Markdown 文章涉及的具体格式规则可查阅 markdownlint 官方 Rules 文档以当前仓库为准提交前执行pnpm md-lint且无告警即可视为格式合格。补充翻译与团队页面的维护命令除文档正文外website的维护还涉及以下辅助命令详见 website/README.md生成翻译文件pnpm write-translations --locale zh-cn或--locale en用于生成/更新国际化翻译占位文件更新团队头像pnpm github-avatar从src/pages/team/data/member.json抓取 GitHub 头像并生成 Base64 字符串存入团队数据目录。这些命令虽然不是文档贡献的必经步骤但在涉及导航文案、页脚等界面国际化内容时同样会用到。提交与审查完成上述修改与本地校验后请按照 代码贡献指南 完成 Fork、分支创建与 PR 提交并按 Commit 格式规范 填写提交信息。PR 创建后社区提交者会针对文档内容与格式进行审查你可直接在同一分支上根据反馈继续更新无需新建 PR审查通过后改动将合入main分支。一句话总结贡献文档的完整链路按规范在website目录编写 →pnpm start --locale zh-cn本地预览 →pnpm md-lint格式校验 → 提交 PR 等待审查合入。掌握这条链路后你就可以为 Apache Fesod 的中英文文档持续贡献力量。赞分享后端【免费下载链接】fesodFast. Easy. Done. Processing spreadsheets without worrying about large files causing OOM.项目地址https://gitcode.com/gh_mirrors/fast/fesod点击查看免费下载相关推荐Apache Fesod 文档贡献指南基于 Docusaurus 官网的文档编写、预览与 PR 提交全流程Apache Fesod 文档贡献指南基于 Docusaurus 官网的文档编写、预览与 PR 提交全流程 本文以 Apache FesodIncubati后端Woodpecker 文档贡献指南基于 Docusaurus 的文档编写、本地预览与版本化发布全流程Woodpecker 文档贡献指南基于 Docusaurus 的文档编写、本地预览与版本化发布全流程 Woodpecker CI 的官方文档站点由 DocusCI/CDDevOpsWoodpecker 文档开发指南基于 Docusaurus 的本地编写、预览与构建全流程Woodpecker 文档开发指南基于 Docusaurus 的本地编写、预览与构建全流程 本文是 Woodpecker CI 开源仓库中面向开发者的文档维护CI/CDDevOps上一篇终极指南3步彻底解决TranslucentTB开机不启动问题让你的Windows任务栏永远透明下一篇如何高效管理中文文献茉莉花插件的终极使用指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考