gitbook
1.0.0
docs-コミュニティ - 開発者ドキュメント-changelog-バグレポート
チームの技術知識を管理するためのプラットフォームであるGitBookへようこそ。
このリポジトリには、GitBookの公開されたコンテンツをレンダリングするために使用されるオープンソースコードが含まれています。
はじめる
貢献
貢献の種類
ライセンス
謝辞
レガシーギットブック
このプロジェクトのローカルバージョンを実行するには、これらの簡単な手順に従ってください。
node.js（バージョン：> = 18.x）
パン
リポジトリをパブリックGithubリポジトリにクローンします。コードを配布する予定の場合は、ソースコードを公開してGNU GPLV3に準拠させます。プライベートリポジトリをクローンするには、商業ライセンスを取得します。
git clone https://github.com/gitbookIO/gitbook.git
プロジェクトのバージョンのnodeを使用していることを確認してください。 nvm use実行すると、ローカルバージョンが正しいバージョンに変更されます。
BUNを介してプロジェクトの依存関係をインストールします。
bun install
ローカル開発サーバーを開始します。
bun dev
Webブラウザで公開されているgitbookスペースを開き、 http://localhost:3000/をプレフィックスします。
例：
http：// localhost：3000/docs.gitbook.com
http：// localhost：3000/open-source.gitbook.io/midjourney
公開されているgitbookサイトは、ローカル開発インスタンスからアクセスでき、コードベースに行った更新はブラウザに反映されます。
bun format ：コードをフォーマットします
bun lint ：コードを癒す
すべてのプルレクエストは、回帰を防ぐために、視覚的およびパフォーマンステストの両方に対してテストされます。
Gitbookのレンダリングエンジンは完全にオープンソースであり、next.jsの上に構築されています。最初のプルリクエストを追加する際のワークフローの詳細をご覧ください。
GitBookに貢献して、技術的な知識を文書化するための最良のツールを構築するのに役立つことをお勧めします。貢献するいくつかの簡単な方法を探している場合は、読み続けて、一般的な貢献について詳しく学びましょう。
GitBook UIはpackages/gitbook/src/intl/translationsにある一連の翻訳ファイルを使用してレンダリングされます。 UIの追加のすべての翻訳を歓迎します。
バグに遭遇したり、修正したい問題を見つけますか？ GitBookに関連する問題の修正を支援すると、すべての人のエクスペリエンスが大幅に向上します。このリポジトリの問題セクションにアクセスして、すでに支援できるバグの種類の詳細をご覧ください。
警告
このプロジェクトを自己ホストすることは可能ですが、このオプションがあなたのニーズに合っていると確信していない限り、これをお勧めしません。
gitbookに特定の機能を追加したいですか？開始するために私たちの寄稿ガイドにアクセスしてください。
自己ホストこのプロジェクトは、将来の更新を維持し、融合する責任を負います。このプロジェクトの分岐および自己ホストのインスタンスのサポート、メンテナンス、または更新を保証することはできません。
コミュニティがGitBookの未来を協力してプッシュすることを可能な限り簡単にしたいので、独自のバージョンを作成するのではなく、製品に直接貢献することをお勧めします。
このプロジェクトを使用すると、GitBook公開されたコンテンツのレンダリング部分を自己ホストできます。自己ホスティングには長所と短所があります。
プロ側では、コンテンツのルックアンドフィールをカスタマイズし、アプリケーションにドキュメントをより適切に埋め込むことができます。
CON側では、公開されたサイトの信頼性について責任を負い、GitBookプラットフォームへの変更をレンダラーに最新の状態に保ちます。
GNU GPLV3ライセンスの下で配布されます。
コードを配布する予定がある場合は、GNU GPLV3に準拠するためにソースコードを公開する必要があります。プライベートリポジトリをクローンするには、商業ライセンスを取得します。
詳細については、 LICENSE参照してください。
[！[gitbook]（https://img.shields.io/static/v1?message=documented%20on%20gitbook＆logo = gitbook&logocolor=ffffff＆label=%20&labelcolor=5c5c5c&color = 3f89a1）]
<a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?message=documented%20on%20gitbook＆logo = gitbook = gitbook&logocolor = fffffffffff＆label =％20&labelor = 5c5color = 5color 「
/> </a>GitBookはこれらのプロジェクトなしでは不可能です。
next.js
パン
Tailwind CSS
フレーマーの動き
GitBookの以前のバージョンとCLIツールは現在廃止されました。古いリポジトリを表示することができ、このブランチでコミットしています。
