Skip to content

Mkdocs - 目次#

Reference#

plugin#

extend#

Mkdocs Material memo#

  • pip install mkdocs にてMkdocsをインストールします。
  • 詳細: Mkdocs

使い方#

  • 以下のコマンドを順に実行することで簡単にローカル環境でwebサイトを構築することができます。
  • mkdocs new project_name
  • cd project_name
  • mkdocs build
  • mkdocs serve

Note

mkdocs serve 実行後、デフォルトで http://127.0.0.1:8000 にて起動します。

Tip

  • mkdocs serve と実行することでローカルでサーバを立ち上げることができます。
  • ローカルで起動した server を外部から接続できるようにするには mkdocs serve コマンドに 以下のようにオプションを付けて実行します。ここではポート番号8000を指定しています。 
    mkdocs serve --dev-addr=0.0.0.0:8000

設定関連#

  • mkdocs.yml に use_directory_urls: false を記述する
  • サイト内リンクは[目次](./index.md) のようにその文書からみた相対パスにて記述すること。

目次の生成#

使用手順

  • npm でinstall : npm install -g doctoc
  • markdownの目次を入れたい箇所に以下を挿入
  • .md ファイルデのあるィレクトリに移動してから、次のコマンドを実行して目次を生成
    • ( READMEは対象のmarkdownのファイル名を指定)
  • doctoc README.md --github

icon#

編集日時#