マークダウン

同僚の皆さん、こんにちは！ 長い学習の旅を経て、誰もが自分の成果を雇用主に示し、最高のプロフェッショナルな側面だけを示したいと考えていますよね? 私はイエスと思う。したがって、プロジェクトを正しく設計して実装することに加えて、それを形式化できる必要があります。雇用主は、プロジェクトのコードをすべて読んで、その内容や含まれる内容を理解するわけではありません。この記事では、最後に前の 2 つ、つまり継続的インテグレーションとコード カバレッジを要約し、オープンソース プロジェクトの「フロント」シートでプロジェクトで使用したものとそれが何を表しているのかを理解しましょう。今日は Markdown について話します。「Markdown とは何ですか?」というよくある質問をします。「これはなぜ?」と考えたら、それがどこで使用されるのか、どのように使用するのかを考えてみましょう。サンプルもあり、それをオープンソース プロジェクトに実装します。じゃ、行こう！

「マークダウン」とは何ですか?

あなたも私もプログラマーなので、すぐに Google にアクセスして最初のWikiリンクを開きます。そこには次のように書かれています。Markdown は、最も読みやすく編集しやすいテキストを書くことを目的として作成された軽量のマークアップ言語ですが、高度な出版物用の言語 (HTML、リッチ テキストなど) への変換。 正直に言うと、これはほとんど完璧な説明だと思います。

なぜこの「マークダウン」が必要なのでしょうか?

正直に言うと、実際にはそれなしでも悪くありません :D しかし、私たちの目標を思い出してください。それは、すでに継続的インテグレーションがあり、Codecov リソースのコード カバレッジ統計が含まれる有能なプロジェクト テンプレートを作成することです。なぜこれについて言及したのでしょうか? さらに、Markdown を使用すると、これらのリソースからデータを取得し、データ自体、またはこの情報を取得する必要がある場所にリダイレクトするバッジを提供できるようになります。すべてを 1 つの「タイトル」ページにまとめておくと、さまざまな場所に散らばるよりも便利ですよね。

どこで使われていますか?

自分のプロジェクトを少なくとも 1 度 GitHub にアップロードしたことがある人なら誰でも、GitHub が README ファイルを作成するようしつこく誘っていることを知っています。 このファイルの拡張子は何ですか? そう、Bolt はMarkdown を知っているのです。すでにご存知のとおり、このファイルはさまざまな形式に非常に簡単に調整でき、必要な HTML に変換できます。ただし、急いですぐに GitHub に直接追加しないで、時間をかけて作業しましょう。

それをどのように扱うか?

まず、お気づきかもしれませんが、これを GitHub に直接追加すると機能します。ただし、たとえば、常に 1 つのプロジェクトだけに追加する必要があるわけではありません。あるいは、どのように作成するかをもっと考えたいと考えています。そして、ここでは GitHub は私たちには適していません。また、一般に、Markdown ファイルを作成する目的は、GitHub にプッシュするためだけではありません。次に、IDEA を通じて直接作成することもできます。これはまさに私たちが行うことですが、すぐにはできません。なぜなら、1 つの小さなファイルを書き込むために強力な開発環境が必要なのでしょうか。ここでは、簡単な Markdown ファイル エディターとそれほど簡単ではない Markdown ファイル エディターのカタログを参照することをお勧めします。私自身としては、Haroopad を選択しました。これは非常にシンプルでアクセスしやすく、作成内容を即座に表現でき (IDEA も同様です)、構文ヒントが備わっています。エディタ ウィンドウは次のようになります。 ここでは、プロジェクトの 1 つに関する既製の README.md を開きました。左側がカンニングペーパー、右側がディスプレイ、中央がテキストです。すべては非常に原始的で単純です。バッジも表示されますが、これについては後ほど説明します。これらのファイルを別の方法で記述する場合でも、心配する必要はありません。異なるのはグラフィカル インターフェイスだけです。テキスト、構文、表示は変更されません。 例 タスクは非常に簡単です。プロジェクトに関する情報 (バッジを含む)、プロジェクトのインポートに関する情報、プロジェクトの実装に関する情報、作成者の連絡先に関する情報が含まれるように README.md を作成します。すでに述べたように、すべては非常に単純で原始的です。本題に入りましょう。

1. タイトル、つまりプロジェクトの名前を書きましょう。

   主要かつ最大の見出しがハッシュ演算子「#」を使用して作成され、その後タイトルが書き込まれます。私たちの場合には：

   # ForJavaRushPublication

2. 次に、少し小さいタイトルを書き、「プロジェクト情報」を書きます。小さいヘッダーの前に「#」が追加されます。

   ## Information

   そして、プロジェクトに関する情報を書いていきます。

3. 記事へのリンクを挿入しましょう。これは非常に簡単に実行できます。Haroopad を使用している場合は、チートシートを入力するだけで、テンプレートが自動的に挿入されます。構文は次のとおりです: " [テキスト](url) ";

4. バッジを入れてみましょう。ここで詳しく見てみましょう。

   まずは、見た目を美しくするために、表の形に並べてみましょう。2列と2列になります。構文は次のようになります。

   そして結果は次のようになります:

   次に、バッジにハイパーリンクを挿入しますが、それはどこで入手できるのでしょうか? 前回の記事で Codecov を入手できる場所を示しましたが、どれを入手するかについては触れていませんでした。Markdown ファイルがあるので、Markdown バッジも必要です。

   それをコピーしてマークダウンの列に貼り付けるだけです。ただし、Codecov は JaCoCo ブランチには存在しますが、マスターには存在しないため、手動で修正する必要があることを忘れないでください。Travis CI バッジはプロジェクト名の真向かいにあり、ビルド ログは次のとおりです。

   バッジを選択すると、設定ウィンドウがポップアップ表示されます。

   必ず Markdown と必要なブランチを選択します。2 つのブランチ用の README.md を作成しますが、master ブランチには Codecov をまだ実装していないため、少し異なります。




5. このプロジェクトをインポートまたはクローンする方法についての情報を書きましょう。これを行う方法については説明しませんが、私の README.md で読むことができます。私たちのプロジェクトで使用したテクノロジーについて、リンクを貼りながら書きます。それでも、これは教育プロジェクトです。さて、連絡先を書いてみましょう。




6. マークダウンの準備ができました。それをプロジェクトに追加するだけで完了です。しかし、一度に全部ではありません！IDEA を開いて、プラグインで Markdown サポートがあることを確認してみましょう。

   私は Ultimate IDEA を持っているので、すべてを持っています。デフォルトではプラグインがインストールされていない可能性がありますが、拡張子が md のファイルを作成すると、それをダウンロードするように求められるはずです。IDEA をダウンロードして再起動します。




7. 作成した Markdown をインポートした後、IDEA を通じて開き、必要に応じて編集します。IDEA 経由では次のようになります。

   私たちはプッシュします。次に、プロジェクトを開くと、そのプロジェクトに関する情報がすぐに読み込まれることがわかります。これが README.md です。

   ここで、バッジをクリックすると、プロジェクト アセンブリに直接ジャンプして、そこに何があるか、どのように表示されているかを確認できます。




8. Codecov Badge をデモンストレーションするために、JaCoCo ブランチにも同じことを行います。これは、JaCoCo ブランチにはまだ README.md が含まれていないためです。その結果、バッジが 2 つになりました。

   Codecov はコード カバレッジの割合を表示します。また、Codecov ページにリダイレクトして詳細なコード カバレッジ レポートを表示することもできます。

役立つリンク

• Wiki がMarkdown について教えてくれること。
• マークダウンエディタディレクトリ;
• 私がお勧めするHaroopad ;
• JetBrains Web サイトの Markdown について。
• 同じ JetBrains 上のMarkdown Navigator 。
• バッジとそれに関するすべて。ここでバッジのスタイルを選択し、自分用にカスタマイズできます。
• オープンソース プロジェクトをアップグレードするにはどうすればよいですか? この記事は、 にも答えます。
• 前の記事

一連の記事をまとめてみましょう

1. 継続的インテグレーションに関する最初の記事では、CI とは何か、その目的、およびその使用方法について説明しました。
2. コード カバレッジに関する 2 番目の記事で、CC を試してみて、CC が何であるか、なぜ必要なのかを理解しました。
3. この記事では、Markdown とは何か、Markdown が必要な理由、および Markdown を効果的に使用する方法について説明しました。

この 3 つの長い記事を読んでいただきありがとうございます。お役に立てば幸いです。本文中に誤字・脱字があるかもしれません。ご清聴ありがとうございました！