Qiitaで記事を書いていきたいので、先にQiitaの記事の書き方を勉強する編 #Qiita

新卒２年目Androidエンジニアです。
最近(?)、株式会社DonutsのOrganizationができました。
Qiitaで記事を書いていこう！のための準備編です。

経緯

なにこれどうやってやるの…？
Qiita 緑背景 とかQiita チェックマークとかでググっても出てこない……

TL;DR

公式のチートシートを見れば本記事を読まずともすべて理解ります。

また、「この記事のそれ、どうやってやるの！？」 と、私のようになったらまずMarkdown で本文を見る機能を使いましょう。

大体解決します。

基本のキ

は割愛します。GitHubのIssueを書くときに使う記法は大体できるので、
そこから更にQiitaを書く時に使えそうなテクニックを抜粋しました。

コードブロック

よく使うのがコードブロックですね。
GitHubでもシンタックスの指定は出来ますが、Qiitaではタイトルの指定ができます。

Qiita

```シンタックス:タイトル
本体
```

例えば、Kotlinのシンタックスハイライトでhoge.ktというファイル名のHogeViewクラスを書きたい場合はこうなります。

Qiita

```Kotlin:hoge.kt
class HogeView @JvmOverloads constructor(
    context: Context,
    attrs: AttributeSet? = null,
    defStyle: Int = 0,
) : ViewGroup(context, attrs, defStyle) {
    ...
}
```

実際にはこのように表示されます。

hoge.kt

class HogeView @JvmOverloads constructor(
    context: Context,
    attrs: AttributeSet? = null,
    defStyle: Int = 0,
) : ViewGroup(context, attrs, defStyle) {
    ...
}

使えるシンタックスについてはQiitaのエディタで候補を出してくれます（便利〜）
シンタックスハイライトが可能な言語については公式の記事をご確認ください。

脚注

本文中でするほどではない用語説明や補足説明をするときなどによく使われます。
具体的な使い方はこう

Qiita

**この文章に注釈をつけます。番号を押すと脚注に飛べます。**[^hoge]
[^hoge]: 注釈内容だよ。↩ を押すと元の文章に戻れます

そのまま使うとこんな感じになります。

この文章に注釈をつけます。番号を押すと脚注に飛べます。¹

脚注は本文中のどこでもよく、自動でページの末尾にまとめてくれます。
数字は[^1]のように数字でつける必要はなく、登場順で番号を振ってくれます。²
複数回呼び出してもOKです。²

絵文字

絵文字、とてもよく使います。普段一番使うのは:bow:³です。

Qiitaの場合もそこは変わらず、エディタで:から打ち始めると候補を出してくれます。

Note

本日の一応のゴールになります。Note記法というそうです。
補足説明を目的とした機能になります。

３種類あり、それぞれ以下のように記述します。
(例文はQiita公式のチートシートからお借りしました。)

info

:::note info
インフォメーション
infoは省略可能です。
:::

warn

:::note warn
警告
○○に注意してください。
:::

alert

:::note alert
より強い警告
○○しないでください。
:::

表示させるとこんな感じになります。

インフォメーション
infoは省略可能です。

警告
○○に注意してください。

より強い警告
○○しないでください。

すごい、本当に出来ました。効果的に使えば視覚的にわかりやすい記事にできそうですね。
ちなみにnote内でもある程度のmarkdown記法が使えます。

こういう使い方をたまに見ますね。

こんな人におすすめ

Androidアプリを作ってみたい人
新卒エンジニアとしての振る舞いに悩んでいる人

ちなみにこれはこんな感じ

Qiita

:::note info
**こんな人におすすめ**

- Androidアプリを作ってみたい人
- 新卒エンジニアとしての振る舞いに悩んでいる人
:::

おわりに

Qiitaの記事を書くに際していいな！と思ったテクニックがあれば随時更新していこうと思います.
アウトプット、頑張ります！

参考

注釈内容だよ。↩ を押すと元の文章に戻れます ↩
注釈内容と脚注へのリンクは前後していても名前が同じであれば大丈夫です。呼び出した箇所が複数の場合、戻るボタンも複数つけてくれます ↩ ↩²
:bow:→。日々感謝と謝罪 ↩