サイトを作成する
この記事では、新たにサイトを作成する方法を説明します
プロジェクトを作成する
プロジェクトを作成すると、作業ディレクトリにサイトの作成を開始するために必要なファイルやディレクトリが作成されます。
この記事では、mydocs
というディレクトリにサイトを作成します。ディレクトリのパスは好きなものを使用できます。
ターミナルやコマンドプロンプトなどを開いて、次のコマンドを実行します。
これで、mydocs
にプロジェクトが作成されました。
mkdocs.yml を編集する
mydocs
直下にmkdocs.yml
という名前のファイルが作成されています。このファイルを開きます。
次のテンプレートをコピーして貼り付けます。
mkdocs.yml
site_name: MyDocs
docs_dir : 'docs'
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
language : ja
theme: lantana
visible_search : true
plugins:
- search:
lang : 'ja'
min_search_length: 2
- macros
- awesome-pages
- git-authors
markdown_extensions:
- attr_list
- pymdownx.highlight:
anchor_linenums: true
- admonition
- pymdownx.arithmatex:
generic : true
- md_in_html
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.snippets
- pymdownx.critic
- pymdownx.caret
- pymdownx.keys
- pymdownx.mark
- pymdownx.tilde
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.magiclink
- pymdownx.striphtml
設定ファイルには、他にもいくつかの項目があります。どのような設定があるかを知るには、設定ファイルを参照してください。
プロジェクトをビルドする
設定が完了したら、プロジェクトをビルドします。
ターミナルで、次のコマンドを実行します。
エラーなくビルドが完了したら、サイトの完成です。完成したサイトを確認する
サイトが完成したら、早速確認してみましょう。 ターミナルで、次のコマンドを実行します。
次に、ブラウザでhttp://127.0.0.1:8000にアクセスします。
これでプロジェクトの作成は完了です。次に、記事を執筆するには、記事を執筆するを参照してください。