情報とドキュメントを保存および整理するためのプラットフォーム。 BookStack の詳細については、公式 Web サイト https://www.bookstackapp.com/ をご覧ください。
インストール手順
ドキュメント
デモインスタンス
管理者ログイン
スクリーンショット
ブックスタックのブログ
問題リスト
Discord チャット
サポートオプション
BookStack は、すぐに使える快適でシンプルなエクスペリエンスを提供する独自のドキュメント プラットフォームです。インスタンスの新規ユーザーは、そのエクスペリエンスが直感的であることがわかり、BookStack でのコンテンツ作成に参加するには基本的なワードプロセッサのスキルのみが必要です。プラットフォームは、高度なパワー機能を必要とするユーザーに提供する必要がありますが、核となるシンプルなユーザー エクスペリエンスを妨げてはなりません。
BookStack は、上記の記述とは異なる目的に使用される拡張可能なプラットフォームとして設計されていません。
開発哲学に関して、BookStack はリラックスした、オープンでポジティブなアプローチを採用しています。結局のところ、これは人々が自分の自由時間を寄付して開発し、保守しているフリーソフトウェアです。
プロジェクトとその起源について詳しくは、こちらの FAQ をご覧ください。
以下に、ブロンズ、シルバー、ゴールドのプロジェクト スポンサーを示します。プロジェクトをサポートしてくださったこれらの企業に多大な感謝を申し上げます。注: リストされているサービスは、いかなる形でも公式 BookStack プロジェクトによってテスト、精査、サポートされていません。
プロジェクト寄付の詳細 - GitHub スポンサー ページ - Ko-fi ページ
BookStack ソース コードの作業に関する詳細については、開発ドキュメントを参照してください。
独自の BookStack インスタンスをカスタマイズまたは拡張したいだけの場合は、BookStack のソース コードを変更せずにこれを実現するためのさまざまなオプションの詳細について、BookStack のハッキング ドキュメント ページを参照してください。
BookStack のバージョン管理スキームと一般的なリリース プロセスの詳細については、ここを参照してください。
BookStack 内のテキストの翻訳は、Crowdin の BookStack プロジェクトを通じて管理されます。一部の文字列には、 :userName
など、コロンで始まる変数が付いています。これらの値は実行時に置き換えられるため、そのままにしておきます。
翻訳に貢献するには、プル リクエストを開く代わりに Crowdin を使用してください。作業中のコードベース内の翻訳は古くなっている可能性があり、コードを介してマージすると競合や同期の問題が発生する可能性があります。何らかの理由で Crowdin を使用できない場合は、お気軽に問題を開いて代替オプションについて話し合ってください。
翻訳を提供できるように新しい言語を Crowdin に追加したい場合は、ここで新しい問題を開いてください。
BookStack 内の翻訳は、BookStack や他のプロジェクトが翻訳を見つけるのに役立つ「Crowdin Global Translation Memory」に提供されることに注意してください。これに貢献することに満足できない場合は、たとえ GitHub 経由で手動であっても、BookStack に翻訳を提供することはお勧めできません。
新しい機能をリクエストしたり、バグや問題を報告したりするために、自由に問題を作成してください。問題を作成するときに指定されたテンプレートに従ってください。
プル リクエストは歓迎ですが、小さな調整でない限り、早めにプル リクエストをオープンするか、意図した変更のイシューを作成して、それがプロジェクトにどのように適合するかを話し合い、マージを計画するのが最善の方法かもしれません。機能リクエストが存在する、またはタグ付けされているからといって、その機能がコア プロジェクトに受け入れられるわけではありません。
プル リクエストは、完了するとdevelopment
にマージされて戻されるため、 development
ブランチから作成する必要があります。これはリリースの公開のみを目的としているため、 release
ブランチへのマージをリクエストしたりしないでください。 CSS または JavaScript コンテンツを変更したい場合は、 resources/
にあるソース ファイルを編集してください。 public
内の CSS または JS ファイルはこれらのソース ファイルから構築されるため、直接編集しないでください。
プロジェクトの行動規範はここでご覧いただけます。
BookStack インスタンスを管理するためのセキュリティ情報は、こちらのドキュメント サイトにあります。
新しい潜在的なセキュリティ上の懸念について通知を受け取りたい場合は、BookStack セキュリティ メーリング リストにサインアップしてください。
セキュリティ上の懸念を報告したい場合は、その詳細についてここで確認できます。
私たちは、BookStack をできるだけ多くの人がアクセスできるようにしたいと考えています。リリースごとに厳密にテストするわけではありませんが、可能であれば少なくとも WCAG 2.1 レベル A 標準を目指しています。アクセシビリティの問題に遭遇した場合は、お気軽に問題を開いてください。
プロジェクトのドキュメントとブログを含む Web サイトは、BookStackApp/Web サイト リポジトリにあります。
BookStack ソースは MIT ライセンスに基づいて提供されます。
BookStack によって使用され、BookStack に含まれるライブラリは、独自のライセンスと著作権に基づいて提供されます。多くのコア依存関係のライセンスは以下の帰属リストにありますが、これは BookStack 内で使用されるすべてのプロジェクトの完全なリストではありません。
BookStack の構築と改善に取り組んできた偉大な人々をここで見ることができます。 GitHub または Crowdin を通じて翻訳を提供した素晴らしい人々は、ここで見ることができます。
以下は、BookStack の構築に使用される優れたオープンソース プロジェクトです。注: これは、アクティブな BookStack インスタンスで使用されるすべてのライブラリとプロジェクトの完全なリストではありません。
Laravel - MIT
TinyMCE - MIT
語彙 - MIT
コードミラー - MIT
並べ替え可能 - MIT
Google マテリアル アイコン - Apache-2.0
markdown-it および markdown-it-task-lists - MIT および ISC
Dompdf - LGPL v2.1
KnpLabs/snappy - MIT
WKHTMLtoPDF - LGPL v3.0
Diagrams.net -埋め込みバージョン規約 / ソース プロジェクト - Apache-2.0
OneLogin の SAML PHP ツールキット - MIT
League/CommonMark - BSD-3-Clause
リーグ/フライシステム - MIT
League/html からマークダウンへ - MIT
League/oauth2 クライアント - MIT
pragmarx/google2fa - MIT
Bacon/BaconQrCode - BSD-2 条項
phpseclib - MIT
時計仕掛け - MIT
PHPStan とララスタン - MIT と MIT
PHP_CodeSniffer - BSD 3 節
JakeArchibald/IDB-Keyval - Apache-2.0
NPM および Composer パッケージ マネージャー経由でインポートおよび使用される JavaScript および PHP プロジェクトとそのライセンスの詳細については、dev/licensing/js-library-licenses.txt および dev/licensing/php-library-licenses を参照してください。 txt ファイル。