ページ追加方法#

Material for MkDocs#

本ドキュメントは Material For MkDocs を使用しています。
ここに書かれていないような詳しい使い方はこちらを参考にすると良いです。

ディレクトリ構造#

docsディレクトリは markdown ファイルを保管する場所です。
ディレクトリ内には、common (共通)、mechanical (機械班)、circuit (回路班)、control (制御班)、education (教育資料)があります。

mkdocs.ymlは追加した markdown ファイルを登録する設定ファイルです。

docs
|- common (共通)
|- mechanical (機械班)
|- circuit (回路班)
|- control (制御班)
|- education (教育資料)
mkdocs.yml

ブランチ規則#

mainブランチから作業用のブランチを切って作業を行います。

Style#

<type>/<alias>

Type#

main: プロダクション用ブランチ
feature: 開発用ブランチ

例#

Power Drive のドキュメントを作成する場合のブランチ名

feature/ad-power-drive-document

コミット規則#

Template#

<type>: <subject>

Type#

feat: 新機能
change: 修正・削除

Subject#

コミットの説明文になります。原則日本語を使ってください。

例#

Power Drive のドキュメントを追加した場合

feat: Power Driveのドキュメントを追加

ページ追加#

(任意) mkdocs-materialをインストールして、mkdocs serveコマンドを打つ。
追加したいページのジャンルのディレクトリに移動します。例）機械班ならmechanical
追加するトピックの名前でディレクトリを作成します。例）「Fusion の使い方」ならhow-to-use-fusion
作成したディレクトリにindex.mdを作成する。
mkdocs.ymlに追加する。

mkdocs.yml

# ...

nav:
  - ホーム:
      - index.md
  - 共通:
      - common/index.md
      - ページ追加方法: common/create-new-document/index.md
  - 機械:
      - mechanical/index.md
      # 例の場合だとここに追加!
      # タイトル: ファイルの場所 の形式で書く
      - Fusionの使い方: mechanical/how-to-use-fusion/index.md
  - 回路:
      - circuit/index.md
  - 制御:
      - control/index.md
  - 教育:
      - education/index.md
# ...

Markdown 形式でページ内容を書く

(例) mechanical/how-to-use-fusion/index.md

# Fusion の使い方

機械班では Fusion を使ってます。使い方を紹介。

## 新規ファイルを作成

...

コミット
変更・追加したファイルをコミットしてください。