Repolode
docsifyjs

docsifyjs/docsify

ビルド不要でMarkdownファイルをWebサイトに変換するドキュメントサイトジェネレーター。

スター
31,556
フォーク
5,784
未解決の Issue
102
最終コミット
7 時間前

これは何?

Docsifyは、ビルド時に静的HTMLファイルを生成せず、1つ以上のMarkdownファイルからドキュメントサイトを作成します。ページはブラウザー上でレンダリングされるため、Markdownでコンテンツを書き、任意の静的WebサーバーやGitHub Pagesからフォルダーを配信するだけで、コンパイルなしにサイトを表示できます。

軽量なプロジェクトで、全文検索プラグイン、複数の組み込みテーマ、絵文字への対応、サイトを拡張するためのプラグインAPIを備えています。別途Docsify CLIも利用でき、UNPKG、jsDelivr、cdnjsなどの一般的なCDNからライブラリを読み込めます。

コードと同じリポジトリに置き、Markdownを直接編集して更新できるプロジェクトドキュメントに適しています。

主な機能

  • 01ビルド不要でMarkdownファイルをWebサイトとして表示
  • 02任意の静的WebサーバーやGitHub Pagesで動作
  • 03全文検索プラグインを搭載
  • 04複数の組み込みテーマを提供
  • 05カスタマイズ用のプラグインAPIを提供
  • 06絵文字に対応

ユースケース

  • Gitリポジトリ内でソースコードと一緒にプロジェクトドキュメントを公開する
  • 静的サイトジェネレーターのパイプラインを使わずにGitHub Pagesでドキュメントサイトを公開する
  • 既存のMarkdownメモから社内ナレッジベースを手軽に作成する

クイックスタート

  1. 1

    GitHub のすぐに使える Docsify Template を使い、静的 Web サーバーまたは GitHub Pages で公開します

  2. 2

    公式ドキュメントサイトでクイックスタートチュートリアルを読みます

トピック

よくある質問

docsify とは?
ビルド不要でMarkdownファイルをWebサイトに変換するドキュメントサイトジェネレーター。 Docsifyは、ビルド時に静的HTMLファイルを生成せず、1つ以上のMarkdownファイルからドキュメントサイトを作成します。ページはブラウザー上でレンダリングされるため、Markdownでコンテンツを書き、任意の静的WebサーバーやGitHub Pagesからフォルダーを配信するだけで、コンパイルなしにサイトを表示できます。
docsify は無料で使えますか?ライセンスは?
docsify は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
docsify は今もメンテナンスされていますか?
活発にメンテナンス中。docsify の最終コミットは 2026年10月21日 です。
docsify は何に使えますか?
Gitリポジトリ内でソースコードと一緒にプロジェクトドキュメントを公開する 静的サイトジェネレーターのパイプラインを使わずにGitHub Pagesでドキュメントサイトを公開する 既存のMarkdownメモから社内ナレッジベースを手軽に作成する
docsify のインストール方法は?
GitHub のすぐに使える Docsify Template を使い、静的 Web サーバーまたは GitHub Pages で公開します 公式ドキュメントサイトでクイックスタートチュートリアルを読みます
docsify はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/docsifyjs/docsify

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト