1. ホーム
  2. github

[解決済み] GithubのREADME.mdでディレクトリツリーを表現する方法はありますか?

2022-11-30 17:58:24

質問

私のGithubsレポでは ドキュメント というようなディレクトリツリー構造を表現したい。

Github風味のマークダウンで、アスキーアートで作成する以外に方法はないのでしょうか?

ということは、基本的には この質問 のようなものですが、github特有のソリューションがあるのかどうか疑問に思っています。

どのように解決するのでしょうか?

直接は無理です。手作業で作成し、自分で入れる必要があります。ローカルで *nix ボックスを使用していて、utf を使用していると仮定すると、次のようになります。 ツリー がうまく生成してくれるでしょう(あなたが上で使用した例はこれが生成したものだと思います)。

を意味すると仮定すると readme.md をドキュメント作成の対象としているのなら、それを自動化する唯一の方法は tree を実行し、readme ファイルにそれを埋め込むことです。出力が変更された場合にのみreadmeを更新するよう、diffを実行する必要があります。

もしあなたがgithubページを通して別々のドキュメントを管理しているなら、あなたは何をしますか? は、ローカルでjekyll(または他のジェネレータ)を使用して、自分で静的なページをプッシュするように切り替えてください。その後、あなたは潜在的にプラグイン/シェルスクリプト*/手動変更(それらが大きく変化しない場合)、または上記と同じ方法を使用してのいずれかをしたい変更を実装することができます。

*コミットフックに統合する場合、ページを変更するための余分なステップを追加することを避けることができます。