---

Mkdocs

关于

• 本文档的撰写软件
• markdown to static HTML site
• Origin

警告

• Mkdocs中文文档并非最新版本，可能出现差错（严重致命错误）

安装（Windows）

• https://www.python.org/downloads/windows/安装Python（安装时勾选讲Python加入PATH）
• https://pip.pypa.io/en/latest/installing/下载get-pip.py
• 下载完毕后（且Python安装完毕后）可以直接打开get-pip.py，也可以在此处打开命令行（或PowerShell，下同）输入指令python get-pip.py或start get-pip.py
• 安装mkdocs，命令行输入pip install mkdocs

局域网访问

• mkdocs serve命令会默认监听localhost(127.0.0.1:8000)
• 如此在局域网就无法访问（Eg:局域网IP：192.168.1.100）
• 在配置文件中进行修改：将默认IP改为0.0.0.0:8000（监听本地所有ip）
• 
• 该文件一般位于:%USERPROFILE%\AppData\Local\Programs\Python\Python37\Lib\site-packages\mkdocs\config

样式/主题（Themes）

• 一些Mkdocs主题
• 比较常用有：原版、ReadTheDocs
• 此处使用Material主题

Google-Material

• Origin
• Google设计的一种跨平台、跨设备的的设计标准
• 如今你所见到的Google产品，基本样式都相同，无论是网页版本或是移动App，这需要归功于Material-design

Material-UI

• Origin
• Material-Design的React组件
• 不想用React，也有MaterialUI的Bootstrap版本，具体见润梦的正式报名页面

Material

• DOCS
• Github
• 使用字体：Ubuntu、Ubuntu Mono（从GoogleFont）
• 为了方便PDF打印，在源样板的页面头部增加了目录，不需要时可删除

  @@ material/base.html 行 151
  <div class="md-content">
      <article class="md-content__inner md-typeset">
        {% include "partials/toc.html" %}
        <hr/>
        {% block content %}
          {% if page.edit_url %}
            <a href="{{ page.edit_url }}" title="{{ lang.t('edit.link.title') }}" class="md-icon md-content__icon">&#xE3C9;</a>
          {% endif %}