freeCodeCamp/devdocs

これは何？

主な機能

• 01インストール済みの多数のドキュメントセットを横断して即座に検索できます。
• 02ドキュメントをダウンロードすればオフラインで利用できます。
• 03キーボードによるフルナビゲーションとダークテーマに対応しています。
• 04DockerまたはRubyを使った手動セットアップで実行できます。
• 05ドキュメントのダウンロード、生成、パッケージ化に使えるThor CLIが付属しています。

ユースケース

• ブラウザーを離れずに、言語やフレームワークのAPIリファレンスを調べる。
• 移動中や通信が不安定な環境で、ドキュメントをオフラインで読む。
• Dockerを使って、非公開のセルフホスト型ドキュメントブラウザーを運用する。
• 社内利用向けのカスタムドキュメントセットを作成・保守する。

クイックスタート

1. 1

   DockerでDevDocsをローカル実行する

   docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest

使う前に知っておきたいこと

• !現在、プロジェクトはメンテナーを募集しているため、長期的な保守は不透明です。
• !手動インストールにはRuby 4.0.7、libcurl、bsdtar、JavaScriptランタイムが必要で、ドキュメントセットは別途ダウンロードする必要があります。

トピック

よくある質問

devdocs とは？

多くの開発者向けリファレンスドキュメントを、検索やオフライン利用に対応したWebインターフェースに集約するAPIドキュメントブラウザー。 DevDocsは、さまざまなプログラミング言語、フレームワーク、ツールのリファレンスドキュメントを、即時検索、キーボードショートカット、ダークテーマ、モバイル向けレイアウトを備えた単一のWebインターフェースにまとめます。ユーザーはインストールするドキュメントセットを選べるため、必要なものだけを読み込めます。

devdocs は無料で使えますか？ライセンスは？

devdocs は MPL-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

devdocs は今もメンテナンスされていますか？

活発にメンテナンス中。devdocs の最終コミットは 2026年10月21日 です。

devdocs は何に使えますか？

ブラウザーを離れずに、言語やフレームワークのAPIリファレンスを調べる。 移動中や通信が不安定な環境で、ドキュメントをオフラインで読む。 Dockerを使って、非公開のセルフホスト型ドキュメントブラウザーを運用する。 社内利用向けのカスタムドキュメントセットを作成・保守する。

devdocs のインストール方法は？

DockerでDevDocsをローカル実行する: docker run --name devdocs -d -p 9292:9292 ghcr.io/freecodecamp/devdocs:latest

devdocs はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/freeCodeCamp/devdocs