記事を執筆する

この記事では、記事を執筆する方法を説明します


taiseiue | 2022-10-22

ファイルを作成する

ガイド:サイトを作成するの手順でサイトを作成していれば、記事はdocsというディレクトリ内にあります。

このディレクトリに記事の名前.mdという名前でファイルを作成します。ディレクトリを作成して、その中に含めることもできます。

Tip

ディレクトリ内にindex.mdというファイルを作成すると、index.htmlのようにトップページとなります。

記事を執筆する

記事の実際の表示を確認しながら記事を執筆できます。 ターミナルで、次のコマンドを実行します。

Bash
mkdocs serve

次に、ブラウザでhttp://127.0.0.1:8000にアクセスし、左のナビバーから記事をクリックして開きます。

さぁ、いよいよ執筆開始です。任意のエディターで先ほど作成したファイルを編集します。次の例のように、記事はマークダウン形式で執筆します。

Markdown
# 記事の例
Lantanaを使って記事を執筆してみました。

記事の執筆はこんなに**簡単**です。

どのような構文があるかを知るには、マークダウンを参照してください。

記事のタイトルや概要を記述するには、メタタグを使用します。 次の例のように、メタタグはファイルの先頭に記述します。

Markdown
---
title: 記事の例
summary: この記事はサンプルです
author : me
date : 2022-10-22
---

どのような情報を指定できるかを知るには、メタタグを参照してください。

これでこのガイドは完了です!必要になったら、いつでもこのガイドに戻ってきてください。