ウィキページを追加または編集する
ウィキページは、GitHub 上で直接、あるいはコマンドラインを使ってローカルで追加および編集できます。
Wikis are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see "GitHub's products."
このガイドの内容
ウィキページを追加する
-
On GitHub, navigate to the main page of the repository.
-
Under your repository name, click Wiki.
-
ページの右上にある [New Page] をクリックします。
-
Markdown 以外のフォーマットで書くために、[Edit mode] ドロップダウンメニューを使い、他のフォーマットをクリックすることもできます。
-
テキストエディタを使って、ページの内容を追加してください。
-
追加しようとしている新しいファイルを説明するコミットメッセージを入力してください。
-
変更を wiki にコミットするには [Save Page] をクリックします。
ウィキページを編集する
-
On GitHub, navigate to the main page of the repository.
-
Under your repository name, click Wiki.
-
ウィキサイドバーを使用して、変更したいページに移動してください。 ページの右上にある [Edit] をクリックしてください。
-
Use the text editor edit the page's content.
-
Type a commit message describing your changes.
-
変更を wiki にコミットするには [Save Page] をクリックします。
ローカルでウィキページを追加または編集する
ウィキは Git のリポジトリの一部なので、Git ワークフローを使ってローカルで変更を加え、リポジトリにプッシュできます。
手元のコンピュータへウィキをクローンする
すべてのウィキは、その内容をあなたのコンピュータにクローンする簡単な方法を提供しています。
GitHub Desktopを使用している場合は、[Clone in Desktop] をクリックして、wiki を手元のコンピュータにコピーします。
あるいは、提供された URL で手元のコンピュータにリポジトリをクローンできます。
$ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
# ローカルに wiki をクローンwiki をクローンした後は、新しいファイルの追加、既存のファイルの編集、変更のコミットができます。 wiki で作業をする際に、あなたとコラボレータはブランチを作成することができますが、master ブランチにプッシュされた変更だけがライブになり、読者が読めるようになります。
ウィキのファイル名について
wiki のページのタイトルはファイル名で決まり、ファイルの拡張子で wiki の内容の描画方法が決まります。
wiki は弊社のオープンソースマークアップライブラリでマークアップに変換され、ライブラリはファイルの拡張子によって使用するコンバータが決定されます。 For example, if you name a file foo.md or foo.markdown, wiki will use the Markdown converter, while a file named foo.textile will use the Textile converter.
wiki ページのタイトルには \ / : * ? " < > | という文字は使わないでください。 特定のオペレーティングシステムのユーザは、これらの文字を含むファイル名を扱えません。 内容を書く上では、拡張子にマッチしたマークアップ言語を使ってください。そうなっていない場合、内容は正しく描画されません。