みが市立図書館

Appearance

マークダウン ​

このドキュメントの例のほとんどはMarkdownで書かれています。MarkdownはHonKitのデフォルトのパーサーですが、AsciiDoc syntaxを選択することもできます。

HonKitで使えるMarkdown構文の概要を説明します（GitHubと同じですが、一部追加されています）。

見出し ​

見出しを作成するには、見出しテキストの前に1～6個の#記号を付けます。この#の数によって、見出しの大きさが決まります。

markdown
# これは<h1>タグです
## これは<h2>タグです
###### これは<h6>タグです

HonKitは、ヘッダIDを明示的に設定するための素晴らしい方法をサポートしています。ヘッダテキストに続けて、開きの中括弧（テキストとは少なくとも1つのスペースで区切られる）、ハッシュ、ID、閉じの中括弧を記述すると、IDがヘッダに設定されます。atxスタイルのヘッダーの末尾のハッシュの機能を使用する場合、ヘッダーIDは末尾のハッシュの後に行かなければなりません。例えば

markdown
こんにちは {#id}
-----

# こんにちは {#id}

# こんにちは # {#id}

段落と改行 ​

段落とは、1行以上の連続したテキストを、1行以上の空白行で区切ったものです。(空白行とは、空白のように見える行のことで、スペースやタブ以外何もない行は空白とみなされます)。通常の段落は、スペースやタブでインデントしてはいけません。

ここでまずは1行だけご紹介します。

この行は上の行と2つの改行で区切られているので*分離された段落*となります。

強調 ​

markdown
*このテキストはイタリックになります*
_これもイタリックになります_

**このテキストは太字になります**
__これも太字になります__

~~このテキストは取り消されます~~

_組み合わせることが**できます**_

リスト ​

Markdownは順序付き（番号付き）リストと順序なし（箇条書き）リストをサポートしています。

順不同 ​

順序なしリストでは、アスタリスク、プラス、ハイフンをリストの目印として使い分けます。

markdown
* 項目 1
* 項目 2
  * 項目 2a
  * 項目 2b
順序付き ​

順序付きリストでは、番号の後にピリオドを使用します。

markdown
1. 項目 1
2. 項目 2
3. 項目 3
   * 項目 3a
   * 項目 3b

Markdownはインラインとリファレンスの2つのスタイルのリンクをサポートしています。

テキストを角括弧で囲み、リンク先のURLを括弧で囲むと、簡単なリンクが作成できます。

markdown
これは[例](http://example.com/ "タイトル")のインラインリンクで、タイトルがあります。

[このリンク](http://example.net/)にはtitle属性がありません。

リンクは相対パス・アンカー・絶対URLを指すことができます。

参考文献 ​

テキストフローを妨げないリンクを作成する別の方法があります。URLとタイトルを参照名で定義し、この参照名をリンクURLの代わりに角括弧で囲みます。

markdown
これは[例][id]参照スタイルのリンクです。

そして、文書内の任意の場所にこのようなリンクラベルを1行で定義します。

markdown
[id]: http://example.com/  "オプションのタイトルはこちら"

画像 ​

画像はリンクと同様の方法で作成できます。角括弧の前に感嘆符を使用するだけです。リンクテキストは画像の代替テキストになり、リンクURLは画像のソースを指定します。

markdown
画像: ![gras](img/image.jpg)

ブロッククォート ​

ブロッククオートは > マーカとオプションのスペースで開始されます。ブロッククオートの中では、どのようなブロックレベルの要素でも使うことができます。

markdown
カニエ・ウェストが言ったように:

> 私たちは未来を生きているのだから
> 現在が過去である。

テーブル ​

単語のリストを組み立て、ハイフン - で区切り（最初の行の場合）、各列をパイプ | で区切ることでテーブルを作成することができます。

markdown
| ファーストヘッダー  | セカンドヘッダー |
| ------------- | ------------- |
| コンテンツセル  | コンテンツセル  |
| コンテンツセル  | コンテンツセル  |

表の両端にあるパイプはオプションです。セルの幅は様々で列の中で完全に揃える必要はありません。ヘッダー行の各列には少なくとも3つのハイフンが必要です。

コード ​

Markdownは2つの異なるコードブロックスタイルをサポートします。一方は4つのスペースまたは1つのタブでインデントされた行を使用し、もう一方はチルダ文字を区切り文字として使用します - したがって、コンテンツはインデントされる必要がありません。

markdown
これはサンプルコードブロックです。

    続きはこちら
フェンス付きコードブロック ​

コードブロックの前後にトリプルバックティック ```を置くと、フェンス付きのコードブロックを作成することができます。生の書式を読みやすくするために、コードブロックの前後に空白行を置くことをお勧めします。

```
function test() {
  console.log("この関数の前に空白行があることにお気づきでしょうか？");
}
```
シンタックスハイライト ​

オプションで言語識別子を追加すると、フェンスで囲まれたコードブロックのシンタックスハイライトを有効にすることができます。

例えば、Rubyのコードをシンタックスハイライトする場合。

```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
インラインコード ​

テキストフレーズは、バックティックで囲むことにより、コードとしてマークアップすることができます。

Use `honkit` to convert the `text` in markdown
syntax to HTML.

脚注 ​

HonKitは、このような脚注のための簡単な構文をサポートしています。脚注は、各ページからの相対参照です。

markdown
脚注参照前のテキスト。[^2]

[^2]: 脚注に入れるべきコメント

HTML ​

HonKitはテキスト中の生のHTMLの使用をサポートします。HTML中のMarkdownシンタックスは処理されません。

<div>
このマークダウンは **パースされません** 。
</div>

水平方向の罫線 ​

水平方向の罫線は、空白行に3つ以上のアスタリスク、ダッシュ、アンダースコアを使用し、オプションでスペースまたはタブで区切って挿入することができます。

markdown
3つ以上の...

---

ハイフン

***

アスタリスク

Markdownのフォーマットを無視する ​

Markdown文字の前に\を使用することで、Markdownフォーマットを無視（またはエスケープ）するようにHonKitに指示することができます。

Let's rename \*our-new-project\* to \*our-old-project\*.

Copyright © 2023-present dolphilia