Skip to content

mkdocs

参考サイト

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs help - Print this help message.

数式

P\cdot Q = \|P\|\|Q\|\cos\alpha

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Note

​ これはノートです。

Tip

​ ヒントです。

Warning

​ これは警告です

Danger

​ これは危険です。

Success

​ これは成功です。

Failure

​ これは失敗です。

Bug

​ これはバグです。

Summary

​ これは概要です。

Mkdocs とは静的サイトジェネレータです。 コンテンツは基本的に markdown1 形式で記述したソースファイルになります。

:fa-external-link: MkDocs

定義語
ここに説明を書きます

:smale:

©

++ctrl+arl+delete++

#include <iostream>
void main() {
    std::cout << "Hello world!" << std::endl;
}

  1. 文書を記述するための軽量マークアップ言語のひとつ