贡献者指南

欢迎阅读 Lynx 网站贡献者指南!本项目是一个大型仓库,为 Lynx 官方文档提供支持。为了帮助您有效地浏览和贡献,我们将指南按特定主题进行了分类。

无论您是撰写博客文章、更新 API 文档,还是添加新示例,本指南都将帮助您了解我们使用的工具和约定。

目录

✍️ 写作指南

  • 指南 - 页面配置、Frontmatter 和编写特定平台内容的最佳实践。
  • 示例 - 如何使用 lynx-example-packages 添加和嵌入交互式示例。
  • 博客 - 如何撰写和发布博客文章。
  • 规范 - 编辑 Lynx Living Specification 的指南。

📚 管理 API

  • API 参考 - API 参考的真实来源。了解 lynx-compat-data<APITable> 以及使用 TypeDoc 生成文档。
  • API 状态 - 使用 API 状态仪表盘工具的指南。

🎨 网站 UI

  • 子站点 - 了解网站如何处理多种语言和上下文(子站点)。
  • MDX 组件参考 - 关于使用内置组件(如徽章、标注和选项卡)的“Storybook 风格”参考。
除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。