本日は小ネタです。
Bitbucketはドキュメンテーションの管理がしやすいです。
例えば、リポジトリでReadme.mdのファイルを追加していると、Bitbucketで該当のリポジトリのトップページで表示されます。
また、Wikiや課題管理も用意されています。
プロジェクトが成長すればするほど、ドキュメントに残さなければいけない事も多くなります。
そうなると、どうしてもドキュメントが長くなってしまい可読性が落ちてしまいます。
もちろん、アンカーリンクを書く事もできますが、見出しが増えるたびに追加するのはとても面倒です。
そこで、目次を自動で挿入してくれる
実装方法
目次を追加するための、BitbucketはTOC(Table Of Contents)マクロが用意されています。
MarkDownの場合は、[TOC]と追加するだけで目次を自動で挿入してくれます。
[TOC] 表示する時に、見出しをアンカーリンク付きのリストで表現してくれます。 ## 項目１ ### 項目１−１ ### 項目１−２ ## 項目２ ### 項目２−１ ### 項目２−２
これは、ReadmeとWikiのページどちらでも使用できます。
もし、ドキュメントをMarkDown以外の方法で書いている場合は下記を参考にしてください。
