OpenShelf
ログイン

BookStack

A platform to create documentation/wiki content built with PHP & Laravel

ドキュメント・WikiConfluenceの代替GitBookの代替MIT
GitHub公式サイト
18,537 スター2,364 フォーク
AIによる要約
ひとことで言うと

情報やドキュメントを本棚・本・チャプター・ページという直感的な階層構造で整理・共有できる、オープンソースのナレッジ管理プラットフォーム。

こんな方におすすめ

・企業：社内Wikiやマニュアル・業務手順書を一元管理し、部署横断での情報共有を効率化できる。検索性の向上により、必要な情報へのアクセス時間を大幅に短縮できる。 ・スタートアップ：製品仕様書や開発ドキュメント、オンボーディング資料をチーム全体で素早く作成・更新でき、急成長期の知識の属人化を防げる。 ・個人事業主・フリーランス：技術メモや業務ノウハウ、クライアント向けドキュメントを体系的に蓄積でき、自分だけのナレッジベースとして長期的に活用できる。

有料サービスとの違い

Confluence や Notion といった有料サービスと異なり、BookStack は完全無料のセルフホスト型であるため、データを自社サーバーで管理でき、ユーザー数による課金が一切発生しない。シンプルな操作性と本棚メタファーによる分かりやすい構造で、ITリテラシーを問わず誰でもすぐに使い始められる。

BookStack

GitHub release license Crowdin Build Status Lint Status php-metrics Alternate Source Repo Stats Discord Mastodon PeerTube YouTube

情報やドキュメントを保存・整理するためのプラットフォームです。BookStack の詳細は公式サイト https://www.bookstackapp.com/ をご覧ください。

プロジェクトの定義

BookStack は、快適でシンプルなすぐに使える体験を提供する、独自の思想を持ったドキュメントプラットフォームです。インスタンスを初めて利用するユーザーでも直感的に使えることを目指しており、BookStack でコンテンツを作成するために必要なのは基本的な文書作成スキルだけです。高度なパワーユーザー向けの機能も提供していますが、それらがコアとなるシンプルなユーザー体験を損なうことはありません。

BookStack は、上記の目的と異なる用途に使われることを想定した拡張性のあるプラットフォームとしては設計されていません。

開発の方針として、BookStack はリラックスした、オープンで前向きなアプローチを採用しています。安定的かつ簡単なアップグレードパスを提供しながら、プラットフォームをゆっくりと、しかし継続的に進化させることを目指しています。

プロジェクトとその成り立ちについて詳しくは、FAQ ページをご覧ください。

プロジェクトスポンサー

以下はブロンズ、シルバー、ゴールドのプロジェクトスポンサーです。 プロジェクトを支援してくださっているこれらの企業に心より感謝いたします。 注意：掲載されているサービスは、BookStack プロジェクトによるテスト・審査・サポートは一切行われていません。

プロジェクトへの寄付の詳細 - GitHub Sponsors ページ - Ko-fi ページ

ゴールドスポンサー

ブロンズスポンサー

開発とテスト

BookStack のソースコードに関する作業の詳細については、開発ドキュメントをご覧ください。

独自の BookStack インスタンスをカスタマイズまたは拡張したい場合は、BookStack のソースコードを変更せずにこれを実現するためのさまざまなオプションについて、BookStack のカスタマイズに関するドキュメントページをご参照ください。

BookStack のバージョン管理スキームと一般的なリリースプロセスの詳細はこちらをご覧ください。

翻訳

BookStack 内のテキスト翻訳は、Crowdin 上の BookStack プロジェクトで管理されています。一部の文字列には :userName のようなコロン付きの変数があります。これらの値は実行時に置換されるため、そのまま残してください。

翻訳への貢献にはプルリクエストではなく Crowdin をご利用ください。作業中のコードベースの翻訳は最新でない場合があり、コードを通じたマージは競合や同期の問題を引き起こす可能性があります。何らかの理由で Crowdin を使用できない場合は、代替オプションについて議論するための Issue をお気軽にお開きください。

翻訳を提供するための新しい言語を Crowdin に追加してほしい場合は、こちらから新しい Issue を作成してください。

BookStack の翻訳は「Crowdin Global Translation Memory」に提供され、BookStack や他のプロジェクトの翻訳に役立てられます。これに貢献することに同意できない場合は、GitHub を含むいかなる方法でも BookStack に翻訳を提供することはお勧めしません。

コントリビュート、Issue、プルリクエスト

新機能のリクエストやバグ・問題の報告のために、お気軽に Issue を作成してください。Issue 作成時に提供されるテンプレートに従ってください。

プルリクエストは歓迎しますが、小さな修正でない限り、プルリクエストを早めに作成するか、意図する変更についてプロジェクトへの適合性やマージ計画を議論するための Issue を作成することをお勧めします。機能リクエストが存在する、またはタグ付けされているからといって、その機能がコアプロジェクトに受け入れられるとは限りません。

プルリクエストは development ブランチから作成してください。完了後に development にマージされます。release ブランチはリリースの公開専用であるため、release ブランチからのビルドやマージリクエストは行わないでください。CSS や JavaScript のコンテンツを変更する場合は、resources/ にあるソースファイルを編集してください。public 内の CSS や JS ファイルはこれらのソースファイルからビルドされるため、直接編集しないでください。

プロジェクトの行動規範はこちらをご覧ください。

セキュリティ

BookStack インスタンスの管理に関するセキュリティ情報は、ドキュメントサイトでご確認いただけます。

新しいセキュリティ上の懸念事項について通知を受け取りたい場合は、BookStack セキュリティメーリングリストに登録できます。

セキュリティ上の懸念を報告したい場合の詳細はこちらをご覧ください。

アクセシビリティ

BookStack をできるだけ多くの方にとってアクセシブルなものに保ちたいと考えています。可能な限り WCAG 2.1 Level A 基準を目指していますが、各リリースごとに厳密なテストを行っているわけではありません。アクセシビリティに関する問題を発見された場合は、お気軽に Issue をお開きください。

ウェブサイト、ドキュメント、ブログ

プロジェクトのドキュメントとブログを含むウェブサイトは、BookStackApp/website リポジトリにあります。

ライセンス

BookStack のソースコードは MIT ライセンスの下で提供されています。

BookStack で使用され、同梱されているライブラリは、それぞれ独自のライセンスと著作権の下で提供されています。 主要な依存関係のライセンスの多くは以下の帰属一覧に記載されていますが、これは BookStack 内で使用されているすべてのプロジェクトの網羅的なリストではありません。

帰属

BookStack の構築と改善に貢献してくださった素晴らしい方々はこちらでご覧いただけます。GitHub または Crowdin を通じて翻訳を提供してくださった素晴らしい方々はこちらでご覧いただけます。

以下は BookStack の構築に使用されている優れたオープンソースプロジェクトです。 注意：これは実際に動作する BookStack インスタンスで使用されるすべてのライブラリやプロジェクトの網羅的なリストではありません。

NPM および composer パッケージマネージャー経由でインポート・使用される JavaScript および PHP プロジェクトとそのライセンスの詳細な内訳については、dev/licensing/js-library-licenses.txt および dev/licensing/php-library-licenses.txt ファイルをご覧ください。