Docusaurus:プロジェクトを文書化するための優れたツール

ソフトウェアを作成する際の最も重要なタスクのXNUMXつはドキュメントです。残念ながら、この作業を開発する私たちにとっては面倒に思えることもありますが、優れたドキュメントがどのツールの成功のポイントにもなり得ることは誰にとっても秘密ではありません。アプリケーションの正しい操作を理解するためにユーザーに提供されるヘルプ、またはアプリケーションを改善するために他の開発者に提供される情報。

プロジェクトを簡単な方法で文書化できる非常に優れたアプリケーションがあります。実際に必要なものよりも多くのものを提供する傾向があるものもあれば、複雑なインストールが必要なものもあります。 プロジェクトを文書化するツール 準拠しており、使用とインストールが非常に簡単なのがDocusaurusです。

ドクサウルスとは何ですか?

ドクサウルス のためのプロジェクトです オープンソースツールのWebドキュメントを構築、実装、および保守する、それは言語を使用することができます 値下げ 後でhtmlWebサイトとして公開されるドキュメントを作成するために、同じ方法で、ツールを使用して、Reactを使用してドキュメントWebサイトのデザインを拡張およびカスタマイズできます。

一般に、Facebookプログラミングチームによって開発されたこのオープンソースツールを使用すると、プロジェクトのドキュメントを適切に表示できる美しくて軽いWebサイトを簡単に作成できます。

このツールには、ドキュメントを正しくバージョン管理するための機能、高度な検索エンジン、ドキュメントサイトをリアルタイムでドキュメント化および再設計する可能性、翻訳との統合、およびドキュメント化について心配する必要がなく、作成するためのその他の多くの機能が備わっています。文書化プロセスがより簡単になり、より快適な仕上がりになります。

Docusaurusの簡単な使用法は、開発者によって配布された次のgifで見ることができます。

Docusaurusをインストールするにはどうすればいいですか?

Docusaurusの主な目的は、githubでホストされているオープンソースアプリケーションをドキュメント化するための決定的なツールになることです。そのため、このプラットフォームにドキュメントWebサイトをインストールして実行するのは非常に簡単です。

GithubでDocusaurusを楽しみ始めるには、開発チームが示した手順に従ってください。以下に引用します。

  1. ドキュメントを作成するGitHubリポジトリディレクトリのルートに移動し、次のコマンドを実行します。
  2. yarn global add docusaurus-init or npm install --global docusaurus-init
  3. docusaurus-init

最終結果は、以下に示すようなファイルとディレクトリ構造の作成になります。

プロジェクトを文書化するツール


記事の内容は、次の原則に準拠しています。 編集倫理。 エラーを報告するには、 ここで.

コメント、あなたのコメントを残してください

コメントを残す

あなたのメールアドレスが公開されることはありません。 必須フィールドには付いています *

*

*

  1. データの責任者:MiguelÁngelGatón
  2. データの目的:SPAMの制御、コメント管理。
  3. 正当化:あなたの同意
  4. データの伝達:法的義務がある場合を除き、データが第三者に伝達されることはありません。
  5. データストレージ:Occentus Networks(EU)がホストするデータベース
  6. 権利:いつでも情報を制限、回復、削除できます。

  1.   フアン·ホセ

    試すべき興味深いバグ!