Skip to content

Latest commit

 

History

History
76 lines (57 loc) · 4.77 KB

K:-Github:-Wikiの仕様と運用.md

File metadata and controls

76 lines (57 loc) · 4.77 KB

試行錯誤する中で「マジで?」と思うものがあったので、これらに対してまとめていく

仕様

特殊なファイル名

タイトル(ページ名) 概要 詳細
Home トップページ ページ内リンク
_Sidebar カスタムサイドバー ページ内リンク
_Footer フッター ページ内リンク

詳細は後述する。

できること

トップページを作れる

Homeという名前でファイルを作成すると、Wikiトップを開いたら表示されるページを作る事ができる、 これがなければ、テーブル形式でページタイトルのリンク集が作られる(デフォルトのサイドバー?)

サイドバーをカスタマイズできる

_Sidebarという名前でファイルを作成すると、すべてのページに表示されるサイドバーを自由に作成できる。 また、デフォルトのサイドバーと共存できるので、うまく使い分けたりさせられそう。

ただし、アフィリエイトサイトあるあるのような広告リンクを貼り付ける場所にしてしまうと、デフォルトサイドバーが閉じた状態で表示されることになってしまうので非推奨。 また、考えようによっては問題点ともなってしまうので、このWikiでは採用していない。(後述)

フッターを作れる

_Footerという名前でファイルを作成すると、すべてのページにフッターを置く事ができる。 うまく使えば面白い事ができそう

見出しタグをアコーディオンで表示できる

Pagesの話になるが、これはいいなと思った。階層化の観点から使いにくいのが難点。

作ったページは、デフォルトサイドバー(Pages)に自動で追加される

激アツ。 手動で作成すると手間なので、最大限活用できる運用方法を考えるとWikiの運用も長続きする。

Wiki内を検索できる

実はないところはないのが検索機能。


できないこと

サイドバーを非表示

ここでいうサイドバーとは、右カラムの「Pages」の項目のこと。 これはWikiのすべてのページを参照できるが、意味を持たせる事が難しい。 そこで、カスタムサイドバー(_Sidebar)を使ってサイドバーを閉じる事で、それっぽい対応をするしかなさそう。

階層化

試しにタイトルに/とか-とか入れても半角スペースに変換されてしまう。 当然Pagesで見た時に階層化という概念など存在しない。 これについては、カスタムサイドバーのリンクで擬似的に階層化して、ファイル名を運用ルールに基づいて設定すると表示させる事で対応可能。 (ファイル名順にソートされているので、命名ルールさえ決めておけばある程度は解決できそう)

ただし、先述のアコーディオンが便利なのでデフォルトのサイドバーを使いたい。 (手動でページを追加していく手間をかけたくない)

Githubのコントリビューションにならない

ドキュメンテーションも立派な貢献だと私は考えているので、この仕様には納得できない。
リポジトリ名.wiki.gitにWikiの更新履歴が管理されているようなので、このログを取り出してリポジトリとして管理すれば問題ない。

Wikiの更新をGithubのコントリビューションにする方法

このスクリプトをcurlで実行する。

Githubとしては本来必要ないリポジトリなので、せめてリポジトリ一覧での検索よけのためプレフィックスに__(リポジトリ名)_wikiとしてコントリビューション用のリポジトリであるとしている。
たとえば、このリポジトリだと__Github_Operation(.wiki)なので____Github_Operation_wikiとなる。

ページにカテゴリやタグ、トピックを設定できない

普通にページを作るだけなら気にならないが、ブログのような運用は難しい。 ここまでやるならGithubPagesを使うべきだろう。

パンくずリストがない

そもそも階層構造ではないので、パンくずリストという考え方がない。 手動で作る必要がある。

埋め込みに対応していない

ほとんどのHTMLタグやJavaScriptが動作しない。
アフィリエイトや広告をつけるならWikiは使えない。