【OSS情報】GitベースWikiシステム「 Gollum 」

Gollumの「概要」

「Gollum」(ゴラム)とは、Git上に構築されたシンプルなWikiシステムです。
「便利なAPI」と「ローカルフロントエンド」を備えています。

ポイント

・シンプル
・軽量動作
・バージョン管理機能
・ローカル編集機能
・さまざまなマークダウンをサポート
・カスタマイズ可能
・高度な機能　：「UML図」「引用」「注釈」「数学表現」

Gollumの「特徴」

Gollumリポジトリ

・コンテンツ = 人間が編集できるテキスト(マークアップ)ファイル
・ページ = 任意の方法でディレクトリに編成
・他のコンテンツを含める　：「画像」「PDF」「ヘッダー」「フッター」

Gollumページ

・さまざまなマークアップで記述可能
・複数の編集手段　：「お気に入りのエディタ」「組み込みWebインターフェース」
・バージョン管理機能

GitHub互換

・「GitHub/GitLab wiki」との互換性を維持
・「GitHub/GitLab wiki」をクローン化して、ローカルで表示(編集)が可能

マークアップ言語サポート

・Markdown
・RDoc
・AsciiDoc
・Creole
・MediaWiki
・Org
・Pod
・ReStructuredText
・Textile

構成ファイル「config.rb」

■Gollumの機能をオーバーライド
・ページ形式を処理する方法をカスタマイズ
・マクロを定義
・フックを登録
・特定コードブロックのレンダリング方法を定義
・テンプレートフィルタを定義

→github.com　→gollum　→gollum　→wiki　→Sample-config.rb

Gollumの「機能」

UMLダイアグラム機能

■ページ上のソースから「PlantUMLダイアグラム」をレンダリング
・シーケンス図
・ケース図
・クラス図
・アクティビティ図
・コンポーネント図
・オブジェクト図
・ワイヤーフレーム図

数式記述機能

・インライン計算
・表示計算

引用機能

・BibTeX文献目録
・Markdownドキュメントの引用＋脚注

→github.com　→gollum　→gollum　→wiki　→BibTeX-and-Citations

コメント機能

・CriticMarkup注釈をサポート

→github.com　→CriticMarkup　→CriticMarkup-toolkit

リダイレクト機能

・ページ名変更後に、自動的に変更後ページにリダイレクト
・手動リダイレクト設定も可能

マクロ機能

■マクロ機能の例
・すべてのWikiページリストを出力
・クリック可能なTOCを出力
・同一ディレクトリ内ページをナビゲートするリンクを作成
・ビデオ(オーディオ)ファイルへのリンクを作成　：HTML5ビデオタグ
・ページにアラートを追加

→github.com　→gollum　→gollum　→wiki　→Standard-Macros

フックによる自動化機能

■ポイント
・特定イベント発生時に処理を自動実行
・ユーザー作成コードもサポート

■フックの例
・Wikiセットアップ直後に実行：「post_wiki_initialize」
・各コミットの直後に実行「post_commit」

→github.com　→gollum　→gollum　→wiki　→Hooks

RSSフィード機能

・Wikiの最新変更に関するフィードを生成

Gollum認証プロジェクト「OmniGollum」

・Gollum単体においてユーザー認証は「非サポート」
・「OmniGollum」により、多数のOAuthプロバイダーを追加して認証を実行できる

→github.com　→arr2036　→omnigollum

シングルサインオン機能「CASサーバ」

・Gollumに基本的なユーザー サポート機能を追加できる
・CASサーバとして「Jasig CAS server」「RubyCas-server」を使用できる

→github.com　→gollum　→gollum　→wiki　→Gollum-via-Rack-and-CAS-SSO

Wiki移行サポート機能「caramelizeプロジェクト」

・サポート済みWiki　：「WikkaWiki」「Redmine Wiki」
・他Wikiシステムを定義するための APIも提供

Gollumの「オフィシャルサイト情報」

GitHubページ

→github.com　→gollum　→gollum

ライセンス情報

Gollumのライセンスは「MIT License」です。

詳細について、こちらを参照ください。

→github.com　→gollum　→gollum　→LICENSE

システム要求

Gollumは「UNIXライクシステム」で動作します。

Windowsでは、JRubyで実行できます。

→github.com　→gollum　→gollum　[→#system-requirements]

インストール

→github.com　→gollum　→gollum　→wiki　→Installation

【お知らせ】ITセミナー「マジセミ」のご紹介

「 マジセミ 」では、日々、多くのIT関連セミナーを開催しています。

参加者のみなさまのために「本当に役立つ情報の提供」を目標としています。

また、「 マジセミ 」を通じて、デジタル関連プロダクト(サービス)との「新たな出会いの場」「新たな体験の場」を創造することで、「IT業界の発展」「製造業の発展」「エンジニアの活躍促進」の実現を目指しています。

多くのセミナーの中から「ご自身のスキルやビジネスを強化できるセミナー」を見つけて、ぜひ一度、ご参加ください。

参考サイト
→github.com　→gollum　→gollum