Mkdocs-Material Tutorial

总喜欢折腾一些没什么用的东西,我又开始了。年初给自己整了个Gitbook技术日记乱七八糟的碎碎念,最后迁移到了博客。前阵子看到有人用Mkdocs-Material写博客,转了一圈官网觉得有点意思,也比Gitbook更好看(比以前的Gitbook好看),于是来整一个做校招笔记。

1. 安装

输入以下命令:

pip install mkdocs-material

2. 创建站点

在Github上创建一个仓库,拉到本地之后在根目录下输入以下命令:

mkdocs new .

输入这个命令之后会生成如下的目录结构

.
├─ docs/
│  └─ index.md
└─ mkdocs.yml

3. 配置

打开mkdocs.yml,添加主题:

site_name: Your site name
theme:
  name: material

添加扩展:

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
      linenums: false
  - toc:
      permalink: true
  - footnotes
  - meta
  - def_list
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_png
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist
  - pymdownx.tilde

其他配置可以在这里看到:Advanced configuration

4. 预览

输入以下命令:

mkdocs serve

于是你就得到了一个乖巧的静态网站,在docs/目录下创建markdown文件就可以愉快的瞎写了。

5. 部署

在包含mkdocs.yml文件的路径下输入以下命令:

mkdocs gh-deploy --force

就可以在https://yourname.github.io/repo_name下看到生成的Mkdocs啦~其中yourname是Github的用户名,�repo_name就是第二步中创建的仓库名称。

校招笔记启动!

6. 搬回Gitbook // Update

偶然发现Gitbook现在非常好!看!了! 于是我又搬回去了:

参考

发表评论

Fill in your details below or click an icon to log in:

WordPress.com 徽标

您正在使用您的 WordPress.com 账号评论。 注销 /  更改 )

Google photo

您正在使用您的 Google 账号评论。 注销 /  更改 )

Twitter picture

您正在使用您的 Twitter 账号评论。 注销 /  更改 )

Facebook photo

您正在使用您的 Facebook 账号评论。 注销 /  更改 )

Connecting to %s