優れた「README.md」は、成功するオープンソース プロジェクトと放棄されたオープンソース プロジェクトの違いを表します。 API ドキュメント、機能比較、構成オプションを表示する最良の方法の 1 つは、表を使用することです。
残念ながら、標準の Markdown ではテーブルを簡単に作成できません。
マークダウンテーブルの闘争
Markdown テーブルを手動で記述すると、次のようになります。
```マークダウン |プロパティ |タイプ |説明 | |---|---|---| | ID |文字列 |一意の識別子 | |タイムアウト |番号 |ミリ秒単位の時間 | 「」
1 行に長い説明を追加すると、コード エディターでテーブル全体が視覚的にずれてしまい、保守と読み取りが非常に困難になります。
ビジュアル生成
最も効率的なワークフローは、ビジュアル グリッドを使用することです。 [Markdown Table Generator](/en/markdown-table-generator) を使用すると、スプレッドシートのようなインターフェイスにコンテンツを入力できます。
列を追加したり、行を削除したり、自然に入力したりできます。完了すると、ツールは完全に配置され、きれいにフォーマットされた Markdown 構文を即座に生成します。それをコピーして README に貼り付けるだけです。
パイプ文字 (`|`) やダッシュと格闘するのはやめて、視覚的にテーブルを生成してみましょう。