コンテンツにスキップ

テキストドキュメントの書き方


テキストドキュメントは Markdown 形式で記述します。Markdown は軽量マークアップ言語であり、構文が簡潔で分かりやすく、学習や使用が容易なため、さまざまなドキュメントの作成に適しています。この記事では、具体的な例を通して Markdown を使用したドキュメント作成方法を紹介します。

見出し

Markdown では 6 レベルの見出しをサポートしており、行頭に 1 ~ 6 個の # 文字を追加することで、異なるレベルの見出しを表します。

# レベル1見出し
## レベル2見出し
### レベル3見出し
#### レベル4見出し
##### レベル5見出し
###### レベル6見出し

効果は以下の通りです:

文字

Markdown は複数の文字スタイルをサポートしており、太字、斜体、取り消し線、下線などがあり、これらのスタイルは組み合わせて使用できます。

*文字斜体*
**文字太字**
***文字斜体太字***
~~文字取り消し~~
~~**文字太字取り消し**~~
~~*文字斜体取り消し*~~
<u>文字下線</u>

効果は以下の通りです:

区切り線

アスタリスク *** またはハイフン --- を 3 つ以上連続して入力することで、区切り線を作成できます。

***
---

効果は以下の通りです:

コード

バッククォート ` を使用してコードをマークします。1 行のコードは 1 つのバッククォートで囲み、複数行のコードブロックは 3 つのバッククォートで囲みます。

1 行のコード:printf("Hello, World!");

複数行のコードブロック:

// C コードサンプル
#include <stdio.h>
int main() {
    printf("Hello, World!");
    return 0;
}
// Java コードサンプル
public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
# Python コードサンプル
print("Hello, World!")

効果は以下の通りです:

テーブル

テーブルは縦棒 | で各列を区切り、ハイフン - でヘッダーとテーブル内容の区切り線を定義し、コロン : で配置を設定します。

|デフォルト形式  | 左揃え | 中央揃え | 右揃え |
| --- | :--- | :---: | ---: |
| テーブル内容  | テーブル内容 | テーブル内容 | テーブル内容 |
| テーブル内容  | テーブル内容 | テーブル内容 | テーブル内容 |

効果は以下の通りです:

ハイパーリンク

[描述文本](链接地址) の形式でハイパーリンクを追加できます。また、<链接地址> を使用して元の URL を直接表示することもできます。

アクセス [Guance](https://console.guance.com/) で詳細情報を取得します。

または直接開く:<https://console.guance.com/>

画像

![替代文本](图片链接) の構文を使用して、ドキュメントに画像を挿入できます。

![avatar](https://static.guance.com/dataflux-icon/official/community-code.png" width="60%" >

フィードバック

このページは役に立ちましたか?