Skip to content

how_to_use_github wiki

Tomoki Kazawa edited this page Apr 15, 2024 · 32 revisions

github-wikiの記法

基本的にmarkdown ただし github方言はあります。

links

  1. GitHub WikiとDiscussionsのご紹介
  2. GitHub Wikiの使い方 – サイドバーを編集する方法【階層表示も】
  3. 【超入門】Markdown記法の使い方 (サンプル付き)
  4. マークダウンことはじめ 1.GitHub Wiki (personal plan)を個人用Wikiとして使ってみた話

Tips for Markdowon

  • 見出し #+半角スペース の後 
  • 番号つき見出し 値+半角ドット+半角スペース の後。 数字はなんでもいい。
  • 改行 文末に半角スペースを2つ付けると、改行する。 <br>でもいける
  • 先頭にハイフンをつけることで、箇条書き
    • 半角スペース2つでインデントをつけることで、階層構造
      -先頭に番号をつけたリストを表示したい場合には、先頭に番号を付けて表現
      -リンクは 角カッコと丸カッコ を組み合わせ

[Connpass](https://rakus.connpass.com/)

  • メタ文字のエスケープは\ (かっこを閉じる場合は最初だけでよい)
  • pre記法 行ごとはスペース4 or タブ
  • code記法(pre記法の一行未満版) バッククウォートで囲む