友人と開発中のWebサービスのAPIドキュメントをどのように公開するか？というのが少し前から迷っていました。候補は次のもの。
- WordPress
- StaticなWebページ
- Confluece
- Markdownで書いてGitリポジトリ
手軽に更新ができて、更新されたことを利用側も簡単に分かるようにしたいというのと、できるだけ手間をかけたくないという点などを考慮して、Markdownでやってみることにしました。
問題は、GitのリポジトリをBitBucketに置くので、BitBucketのサイト上でMarkdownファイルがどの程度プレビューで表示されるのかという点でした。実際に試してみると、大体は期待通りの感じです。まだ、書き始めなので画像などはどうのか？やコードは？などは未確認です。ただ、テーブルは罫線が出ないという点が不満ですが、やり方が何かあるような気もします。
まだ、非公開リポジトリですが、そのサービスが公開された後はパブリックにして、ブラウザのエクステンションやネイティブアプリの開発に使えれば良いなぁと想像しています。
