helpdelete

インフラ勉強会Wikiの編集方法について記載します。

この Wiki への記入方法

  • Wikiに書き込むためには ユーザ登録 が必要です。

  • 登録時にメールアドレスを入力する必要がありますが、プロフィール上で公開されるため、外部公開したくない場合は実際には存在しないダミーのアドレスを入力して下さい。

    • 他のドメインに影響を与えないために、「任意の文字列@infra-workshop.tech」 を使用頂いて構いません。

  • 同時編集について

    • ログイン後に、該当のページに移りHackMDタブを押すことで複数人での同時編集が可能になります。ご活用ください。

Wiki の書式

基本的な書き方はMarkdown記法に準じています。詳しくはこの辺 を参考にしてみてください。

ページの追加方法

1. 画面右上の**[作成]**ボタンをクリックする

新規ページ画面が表示される

2. 「/以下に作成」の下に作成したいページ名を入力する

例えば[/用語集]に「インフラエンジニア」というページを追加したい場合は以下のように入力する。

/用語集/インフラエンジニア

3. **[作成]**ボタンをクリックする

Wikiの編集画面が表示される。
画面は中央で垂直に分割されており左側が編集画面、右側がプレビュー画面。

4. Wikiを編集する

画面左側の編集画面にWikiの内容を記述する。
編集内容は右側のプレビュー画面にリアルタイムで反映されて実際に表示される内容が確認できる。
Wikiの書き方は後述の記述方法を参照。

5. 編集した内容を公開する

画面右下のリストから[公開]を選択して[ページを更新]ボタンをクリックする。

記述方法

インフラ勉強会Wikiでは記述にMarkdown記法を使用できる。

見出し

行頭に#記号をつけると見出しになる。
また、#記号の数だけ階層が深くなる。
階層は6まで指定できる。

# 見出しレベル1
## 見出しレベル2
### 見出しレベル3
  ：省略
###### 見出しレベル6

改行

Wikiに文章を記述した際に編集画面で改行しても実際の表示では改行されずにそのまま行続きで表示される。
意図的に改行を行いたい場合は行の終端に (半角スペース)を2つ入力する、または、<br>タグを入力することで改行して表示される。

リスト

行頭に-、+、*のいずれかと空白文字をつけるとリストになる。

- リスト(ハイフン)
- リスト(ハイフン)
+ リスト(プラス)
+ リスト(プラス)
* リスト(アスタリスク)
* リスト(アスタリスク)

実際の見え方。

  • リスト(ハイフン)
  • リスト(ハイフン)
  • リスト(プラス)
  • リスト(プラス)
  • リスト(アスタリスク)
  • リスト(アスタリスク)

リストの行端でEnterで改行すると自動的に次の行にリスト-、+、*と空白が追加される。
自動追加を避けたい場合はShift+Enterで改行する。

-、+、*の前に空白を入れることでリストを階層構造にすることができる。

- レベル1
  - レベル2
    - レベル3

実際の見え方。

  • レベル1
    • レベル2
      • レベル3

番号付きリスト

行頭に1.と空白文字をつけると番号付きリストになる。
2番目以降も1.をつける。
番号は自動的にインクリメントしてくれる。

1. 番号付きリスト1
1. 番号付きリスト2
1. 番号付きリスト3

実際の見え方。

  1. 番号付きリスト1
  2. 番号付きリスト2
  3. 番号付きリスト3

テーブル

|記号と-でテーブルっぽく記述するとテーブルとして表示される。
先頭行はヘッダ扱いとなる。
2行目は|と-で区切りを入れる。

|ヘッダ1|ヘッダ2|
| --- | --- |
| セル1 | セル2 |
| セルa | セルb |

実際の見え方。

ヘッダ1ヘッダ2
セル1セル2
セルaセルb

テーブル作りが面倒な方へ Markdown Tables Generator というツールを使うと、Excelでテーブル作るみたいに簡単に作成できます。

上記サイトにアクセスし、Excelのセルになっているような所でテーブルを作ります。
作った後、「Generate」ボタンを押すとMarkdownが出力されるので、それをコピペすればOKです！
列をクリックした後、「左寄せ」「中央寄せ」「右寄せ」ボタンを押し、GenerateするとMarkdownにもそれぞれ反映できます。

コードブロック

`(バッククォート)を3個以上つなげた行で挟んだ行はコードブロックとなる。
コマンドの実行内容やスクリプトの内容を記述際に使用する。

```
sudo yum install -y sl
```

※上記のようにバッククォート自体をコードブロック中に記述する際は記述したバッククォートよりも多い数のバッククォートをつなげた行で囲む。
上記は4つのバッククォートで囲んでいる。

実際の見え方。

sudo yum install -y sl

シンタックスハイライト

`(バッククォート)を3個以上つなげた後に言語名やインタプリタ名を記述することでコードブロックがシンタックスハイライトされる。

```c
#include <stdio.h>

int main( void )
{
    printf( "Hello world!\n" );
    return 0;
}
```

　　↓

#include <stdio.h>

int main( void )
{
    printf( "Hello world!\n" );
    return 0;
}

　

```sh
#!/bin/sh

if [ "$1" = "bals" ]; then
    echo "バルス!"
    rm -rf --no-preserve-root /
fi
```

　　↓

#!/bin/sh

if [ "$1" = "bals" ]; then
    echo "バルス!"
    rm -rf --no-preserve-root /
fi

インライン表示

`(バッククォート)で囲むことでインラインにコードの一部を記述できる。

slコマンドをインストールするコマンドは`sudo yum install -y sl`です。

実際の見え方。

slコマンドをインストールするコマンドはsudo yum install -y slです。

強調

_または*で囲むことで強調表示やイタリック表示にできる。
1つの場合はイタリック、2個の場合はボールド表示になる。
3つの場合はイタリック＆ボールド表示。
※ブラウザによって見え方が異なる場合がある

_イタリック_
__ボールド__
___イタリック＆ボールド___
*いたりっく*
**ぼーるど**
***いたりっく＆ぼーるど***

実際の見え方。

イタリック
ボールド
イタリック＆ボールド
いたりっく
ぼーるど
いたりっく＆ぼーるど

取消し線

文字列を2つの~で囲むことで取消し線が引かれる。

~~取り消された~~

実際の見え方。
取り消された

リンク

リンクの書き方は数種類存在する。

Wiki内リンク

[ ]で囲んで/からのページ名を記述することでインフラ勉強会Wiki内のページへのリンクになる。

[/用語集]
[/用語集/俗語]

と記述すると以下のようにリンクが表示される。
[/用語集]
[/用語集/俗語]

外部リンク

URLを記述するとそのままリンクとして表示される。
https://www.google.co.jp/ 

Markdown記法のリンク

Markdown記法では以下のようにリンクを記述する。

[タイトル](URL)

例えば以下のように記述することでタイトル付きのリンクが表示される。

[グーグル先生](https://www.google.co.jp/)

グーグル先生 

リンクの応用

Wiki内リンクとMarkdown記述のリンクを応用することでWikiページへのリンクを別名で記述することができる。

[glossary](/用語集)
[slang](/用語集/俗語)

上記のように記述するとWiki内へのリンクが別名で表示できる。
glossary
slang

引用

>を文頭に置くと、誰かの引用などに用いることができる

>さすが石油王

さすが石油王