izanamiエディターで使用できるマークダウン短縮記法表です。
ボタンが表示されているところは、エディターのボタンを押すことで記法を挿入できる項目です。
Extendedが表記されている項目は、拡張された記法です。
レベル2から5の見出し
## H2
### H3
#### H4レベル2から5の見出しを使用できます。シャープ「#」とテキストの間には、半角スペースを入れてください。
h1 ~ h3 までは、下線が入ります。
言語のエイリアス（短縮記法）
```js
console.log('Hello, World!')
```
バッククオートを使用して言語を指定すると、シンタックスハイライトを使用してコードに色をつけることができます。これにより、コードの可読性が向上し、特定の言語構文を簡単に理解できます。
izanami で使用しているShikiは、VS Code の “TextMate スコープ” を使用してシンタックスハイライトを提供しています。
これらのスコープは VS Code 自体の更新や、新しい言語サポートの追加により更新されることがあります。定期的に VS Code のテーマや言語解析の更新を取り込むことができる仕組みになっているため、izanami でも新しい言語や最新のハイライトルールが自動的に反映される可能性があります。
他の言語やエイリアスについてはLanguagesでご確認ください。
例えば以下のようなエイリアスが使えます。
| 言語の例 | エイリアスの例 |
|---|---|
| TypeScript | ts |
| JavaScript | js |
| GraphQL | gql |
| Shell | sh |
| Python | py |
| Ruby | rb |
| Rust | rs |
| Kotlin | kt |
| Objective-C | objc |
| Visual Basic | vb |
| CodeQL | ql |
| Emacs Lisp | elisp |
| Kotlin | kt |
| Markdown | md |
不具合やエラーなどで動作が安定しない場合、他のシンタックスハイライトライブラリを採用する可能性があります。
ファイル名を表示する
```js:app.js
console.log('Hello, World!')
```
言語名の横に、「:ファイル名」を記載すると、左上にファイル名を表示することができます。
Diff 表示
```js
console.log('削除') // [!code --]
console.log('追加') // [!code ++]
```
コードブロックの中で、コードの差分を表示することができます。[!code --]で削除、[!code ++] で追加を表現します。
1行ハイライト
```js
console.log('ハイライトしない')
console.log('ハイライトしない')
console.log('ハイライトする') // [!code highlight]
console.log('ハイライトしない')
```
1行だけハイライトします。コードブロック内で[!code highlight] を記述します。
複数行ハイライト
```js
// [!code highlight:3]
console.log('ハイライト')
console.log('ハイライト')
console.log('ハイライトしません')
console.log('ハイライトしません')
```
複数行ハイライトする場合、+1 した数値を指定します。
フォーカス
```js
console.log('ブラーがかかります')
console.log('フォーカスします') // [!code focus]
console.log('ブラーがかかります')
```
１行だけフォーカスし、他の行にブラー（ぼかし）がかかります。マウスオーバーすると、全ての行のブラーが解除されます。
iframe 埋め込みコード
https://www.youtube.com/watch?v=xx前後に改行を入れてURLを貼り付けてください。
以下は、自動的に埋め込みコードに変換されます。
対応サービス
- iframe 埋め込みコードは使用できません。
KaTeXによる数式表示
$$
ax^2 + bx + c = 0
$$
KaTeXは数式を表示するためのツールで、ブラウザ上で数式を美しく表示できます。
$$マークで囲まれた数式を表示します。代数、微積分、線形代数、物理、統計、フーリエ変換など、さまざまなトピックに対応した数式を表示できます。
詳細はKaTeXの公式ページでサポートされている数式やコマンド一覧をご覧ください。
ベストプラクティスを伝える
:::success
ベストプラクティス、肯定的な内容、推奨される行動
:::
ベストプラクティス、肯定的な内容、推奨される行動など、好ましい結果を伝えます。
注意を伝える
:::warning
注意が必要な内容や、潜在的な問題、リスク
:::
注意が必要な内容や、潜在的な問題、リスクを伝えます。
補足説明、参考情報を伝える
:::info
情報提供、補足説明、参考情報
:::
情報提供、補足説明、参考情報など
アイデア、提案、改善点を伝える
:::discovery
アイデア、提案、改善点を伝えます
:::
アイデア、提案、改善点を示し、新しい視点やアプローチ
禁止事項を伝える
:::alert
禁止事項を伝えます
:::
禁止事項を示し、避けるべき行動や注意事項を伝えます。
脚注
これは脚注の例です[^1]。
[^1]: これは脚注の内容です。
脚注のリンクを挿入します。コンテンツの下に脚注の情報が表示されます。
リンク
[リンク先を示す言葉](url)リンクを挿入します。文言を選択して挿入することも可能です。
画像の挿入
画像を挿入します。画像は自動で `figure` タグで囲まれ、代替テキストは `figcaption` タグで表示されます。
太字
**太字になります**太字にします。
斜体
*斜体になります*斜体にします。
取り消し線
~~取り消し線が入ります~~取り消し線を引く方法です。
箇条書きリスト
* item 1
* item 2
* item 3箇条書きリストを作成します。
番号付きリスト
1. item 1
2. item 2
3. item 3番号付きリストを作成します。
テーブル
| Header | Header |
| ------ | ------ |
| Cell | Cell |
| Cell | Cell |
テーブルを作成します。
引用
> ここにリンクと引用文を記載します。引用を挿入します。
水平線
---水平線を挿入します。
チェックリスト
- [x] task 1
- [ ] task 2
- [x] task 3
チェックリストを作成します。
インラインコード
`短めのコード`インラインコードを挿入します。
ブログカード
https://github.com/任意のURLを貼り付けるだけでウィジェットが表示されます。
URLの前後に空行を入れてください。
絵文字
:smile:😃 のような絵文字は、挿入ボタンの他にコードでも挿入できます。絵文字コードは、Emoji cheat sheetを参照してください。
Markdown Sheet
izanamiは、さまざまな分野のエンジニアと個人開発者が交流し、情報を共有するプラットフォームです。継続的に新しい技術を学べる場所を提供することを目指しています。プログラミング、デザイン、学術など、関心のある分野に関する作品やノウハウを発信してください。
