ITエンジニア/デザイナ向けにオープンソースを毎日紹介

開発用ドキュメントなどをどこに書いておくか、それは常に問題になります。Markdownで書いて静的サイトに変換しても良いですし、CMSを使う手もあります。Googleサイトのような無料で使えるサービスもあります。

そんな中、今回はGitHubのWikiをCMSとして使うGitNotedを紹介します。

GitNotedの使い方

立ち上げたところです。Web APIだけが用意されています。

ノートを取得する例。

JSONで取り出すこともできます。

GitNotedでは独自のCSSやJavaScriptも配信しており、それを組み合わせることで独自サイトの中にGitHub WikiやGollumの内容を取り込めるようになっています(JavaScriptで取り出すのでSEO的には弱いでしょう)。しかしGitNoted自体がCORSに対応しておらず、筆者環境ではうまく表示できませんでした。この部分は修正が必要かと思われます。

GitNotedはRuby製のオープンソース・ソフトウェア(MIT License)です。

GitHub - frsyuki/gitnoted: Simple document server that works with Github Wiki or Gollum to serve foot notes for external websites just by adding a small script tag

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2