beautiful-docs

Beautiful Docs 是一个精选参考资源，面向为软件或其他面向多用户的项目编写文档的人。它本身不生成文档，而是链接到广受好评的示例和支持资源。 文档示例涵盖语言和框架参考、API 指南、操作系统手册、数据库和开发者服务。条目包括 Redis Commands、GitHub Developer Docs、Django、Ruby on Rails、Stripe、Rust、MongoDB、FastAPI 和 Supabase。部分条目突出特定优点，如交互式示例、版本控制、搜索、简洁写作、图表、导航或语言支持。 第二部分涵盖技术写作和文档设计资源，包括 TomDoc、Write the Docs、Google Developer Documentation Style Guide、API Blueprint 和 Diátaxis。最后一部分列出了用于生成、转换、发布或维护文档的工具，如 Sphinx、MkDocs、Read the Docs、Slate、Docusaurus、VuePress、VitePress、Docsify、Pandoc 和 Doxygen。 该仓库通过拉取请求维护。贡献者需说明条目的实用性，注明自己或原始贡献者，并保持列表的添加顺序。