【GitHub】GitHubのWikiを書く | AdMax Tech Blog
AdMaxSDKの使い方はすべてWikiに書いています。 ライブラリなどを作成してGitHubを使って世に公開したときにREADME.mdに使い方すべてを書いてしまうと、とっても読みづらいです。 どんなライブラリか、対応バージョン、インストール方法など簡単に書けるものはREADME.mdに書くで問題ないと思います。 しかし、細かい使い方やAdMaxSDKみたいにあまり使い方がわかっていない人に対して「SDKを用意したから勝手に使ってください。」という姿勢は失礼だと思ったのでWikiにすべてを書きました。 なので、今回はGitHubにWikiを公開するまでの流れを書きます。 リポジトリの作成 なにはともあれリポジトリを作成します。 ここは割愛させて頂きます。 Wikiの作成 ではさっそくWikiを作成します。 リポジトリの画面の右にWikiのリンクがあるのでそれをクリックしてください。 リン
githubのwikiエンジン"gollum"の導入と細かい設定 - yukke::note
gollumの特徴、良いところなど Markdown, MediaWiki, Textileなど大抵の記法で書ける。 基本的にgitリポジトリ一つで完結しており、MySQLなどのDBが不要で、簡単にprivate wikiを立ち上げられる。 セットアップが非常に楽。 gitで動いているので、バージョン管理や差分、コミットを遡ってrevertする、なんてこともWebのUIから簡単に操作できる。 全文検索も実装されている。 ruby+sinatraで実装されているので、分かる人は拡張を簡単に書ける気がする。 導入 Python 2.5+ (2.7.3推奨)、Ruby 1.8.7+ (1.9.3推奨)とのこと。なのでpythonbrewなりrvmなりrbenvなりで新し目のpython+rubyを入れます。あとはgemからgollum本体をインストールします。 gem install gollu
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
