MkDocs個人的まとめ

調査結果

• mkdocsはWindowsマシンへインストールして動作させることができる。mkdocsの動作にはpythonが必須でこれもインストールする必要あり。
  
  • pythonのインストール
    右のサイトからインストーラをダウンロードしてインストール。https://www.python.org/
  • mkdocsのインストール
    pythonをインストールしたマシン上のターミナルで右のコマンドを実行pip install mkdocs
• mkdocsを使うにはまず「プロジェクト」の作成が必要
  • ターミナルでプロジェクトを作成したいフォルダ(フォルダAとする)へ移動し、mkdocs new <プロジェクト名>と打つと以下の構成でフォルダ、ファイルが生成される

       /<フォルダAへのパス>/<プロジェクト名>/
                                           mkdocs.yml        - 設定ファイル
                                           docs/
                                                index.md     - index.htmlに相当するファイル

• markdownのみをインプットとしてWebサイトを公開できる模様
  mkdocs.ymlがある階層へ移動してコマンドmkdocs serveを実行
  →ローカルでサーバーが立ち上がり　http://127.0.0.1:8000
  でアクセス可能になる

• markdownからhtmlへの変換が可能

  • mkdocs.ymlがある階層へ移動してコマンドmkdocs buildを実行
    /<フォルダAへのパス>/<プロジェクト名>/配下に「site」ディレクトリが作成され、
    siteディレクトリ配下にhtmlやらなんやらが出力される。
    
  • mkdocs.ymlに出力設定ができる？

• 各ファイルは UTF8 + LFで記載する模様。そうしないと各コマンド実行時にエラーが出る。

残調査タスク

• 順番指定できない？
• ヘッダ、フッタの設定はできない？

参考