docusaurus - オープンソースのドキュメント Web サイトを簡単に維持できます。

(Easy to maintain open source documentation websites.)

Created at: 2017-06-21 00:13:53
Language: TypeScript
License: MIT

ドクサウルス

ドクサウルス

フォローする npm バージョン GitHub アクションのステータス PR歓迎 不和チャット コード スタイル: きれい Jestでテスト済み Gitpod すぐにコーディング可能 ネットリファイのステータス CI スコア Vercel でデプロイする Netlify にデプロイする

私たちは Docusaurus v2 に懸命に取り組んでいます。Docusaurus を初めて使用する場合は、v1 の代わりに新しいバージョンを使用してみてください。詳細については、Docusaurus v2 の Web サイトを参照してください。

Docusaurus v1 のドキュメントはv1.docusaurus.ioで入手でき、コードはブランチdocusaurus-v1で入手できます。

序章

Docusaurus は、オープン ソース プロジェクトの Web サイトを簡単に構築、展開、および維持するためのプロジェクトです。

時間がない?5 分間のチュートリアルをご覧ください⏱️!

ヒント: docusaurus.newを使用して、プレイグラウンドで Docusaurus をすぐにテストします。

  • 簡単に始められる

Docusaurus は、できるだけ短時間で実行できるように構築されています。Web サイトの構築プロセスを処理する Docusaurus を構築したので、プロジェクトに集中できます。

  • ローカライズ可能

Docusaurus は、CrowdInを介したローカリゼーション サポートとともに出荷されます。ドキュメントを翻訳することで、国際的なコミュニティに力を与え、成長させます。

  • カスタマイズ可能

Docusaurus には、ホームページ、ドキュメント セクション、ブログ、追加のサポート ページなど、開始するために必要な主要なページとセクションが付属していますが、独自のサイトを作成するためにカスタマイズすることもできます。

インストール

初期化 CLI を使用してサイトを作成します。

npm init docusaurus@latest

詳細については、ドキュメントを参照してください。

貢献する

Docusaurus をリリースしたのは、Facebook の多くの OSS プロジェクトをより適切にスケーリングし、サポートするのに役立つためです。他の組織がこのプロジェクトから利益を得ることができることを願っています。コミュニティからの貢献に感謝します。

行動規範

Facebook は、プロジェクト参加者が遵守することを期待する行動規範を採用しています。どのような行為が許容され、どのような行為が許容されないかを理解できるように、全文をお読みください。

寄稿ガイド

コントリビューションガイドを読んで、開発プロセス、バグ修正と改善を提案する方法、および Docusaurus への変更をビルドしてテストする方法について学んでください。

初心者向けのバグ

私たちのコントリビューション プロセスに慣れていただくために、最初に取り組むべき小さな問題が含まれている可能性がある、初心者向けのバグのリストを用意しています。これは、始めるのに最適な場所です。

コンタクト

連絡先はいくつかあります。

寄稿者

このプロジェクトは、貢献するすべての人々のおかげで存在します。[貢献]。

バッカーズ

すべての支援者に感謝します!🙏 支援者になる

スポンサー

スポンサーになってこのプロジェクトをサポートしてください。あなたのロゴがあなたのウェブサイトへのリンクと共にここに表示されます。スポンサーになる

ライセンス

Docusaurus はMIT ライセンスです。

Docusaurus のドキュメント (フォルダ内

.md
のファイルなど
/docs
) はクリエイティブ コモンズ ライセンスです。

特別な感謝

ブラウザスタックのロゴ

BrowserStackは、オープン ソースへの無料アクセスを提供してくれます。

ロケットバリデーターのロゴ

Rocket Validatorは、HTML マークアップやアクセシビリティの問題を見つけるのに役立ちます。