beautiful-docs

Beautiful Docsは、ソフトウェアや複数ユーザー向けのプロジェクトのためのドキュメントを作成する人のためのキュレーションされたリファレンスです。このプロジェクト自体はドキュメントを生成するものではなく、高く評価されている実例や関連リソースへのリンクを集めたものです。 ドキュメントの実例は、言語やフレームワークのリファレンス、APIガイド、オペレーティングシステムのマニュアル、データベース、開発者向けサービスなど多岐にわたります。掲載項目には、Redis Commands、GitHub Developer Docs、Django、Ruby on Rails、Stripe、Rust、MongoDB、FastAPI、Supabaseなどが含まれます。一部の項目では、インタラクティブなサンプル、バージョニング、検索機能、簡潔な文章、図解、ナビゲーション、多言語対応など、特に優れている点が紹介されています。 2つ目のセクションでは、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など、ドキュメントの生成、変換、公開、保守を行うためのツールがリストアップされています。 このリポジトリはプルリクエストを通じて管理されています。貢献者には、その項目がなぜ有用なのかを説明し、自分自身または元の貢献者を明示し、リストの追加順を維持することが求められています。