使用Mkdocs构建自己的Learning Notes

之前使用过mkdocs构建过项目文档，感觉还不错。最近秋招也陆陆续续的开始了，好多学过的东西差不多都忘了，所以看了看之前记录的一些笔记，于是有了一个构件Learning notes 的想法，把学过的觉得重要的东西构件成文档，也方便随时查阅复习。

我已经将生成的site放在github page了，可以很方便的进行访问，如果有兴趣的话可以瞅瞅：https://smallseven.top/mkdocs-notes/

使用Mkdocs构建部署的流程也很简单，这里做个简单罗列，具体的可以参考官方完整指南。https://markdown-docs-zh.readthedocs.io/zh_CN/latest/

环境：

• 支持Windows/Linux/macOS
• 需要安装 Python 2.7 +
• 需要 pip

1、安装MkDocs

$ pip install mkdocs

运行 mkdocs help 可以检查是否正确安装。

2、输入以下命令构建项目

$ mkdocs new project

project 是指项目名，你要在那个目录下创建，就切换到那个目录下 Windows的cmd 命令行和Linux的终端命令都是类似操作。

构建好的项目里有一个配置文件 mkdocs.yml, 和一个包含文档源码的 docs 文件夹. 在 docs 文件夹里包含了一个名为 index.md 的文档.

3、启动内建服务器，进行预览

$ mkdocs serve

它会自动使用8000 端口，在浏览器中打开<http://127.0.0.1:8000/>就可以完成效果的预览。之后就是修改配置文件 mkdocs.yml ，自己可以添加一些配置信息，包括站点名称，文档页面等，很简单。

4、使用以下命令,创建新的页面

$ curl 'jaspervdj.be/lorem-markdownum/markdown.txt' > docs/about.md

其实根本不用那么麻烦，在Windows下只用像创建文件目录那样操作即可，所有的文件都在docs 文件目录内。

5、主要是修改配置文件 mkdocs.yml，这个决定了你的站点结构，你可以根据你自己的实际情况修改。例如：

site_name: Learning Notes

nav:
nav:
- 主页: index.md

- 面试知识:  
        - 面试要点-操作系统篇: notes/OS-notes-keynote.md
        - 面试要点-计算机网络篇: notes/computer-network-keynote.md

- About: about.md

theme: readthedocs

6、站点生成

$ mkdocs build

该命令创建了一个 site 新目录. 里面的文件就是你的站点资源文件，你可以把这些文件部署到服务器上或者github page上，就可以进行访问了。大概流程就这些，其实和 hexo 生成站点差不多。

记录笔记其实是有一个误区就是以为自己记录了就理解了学会了，其实不然，很多时候可能只是扫描了一遍，并没有学到啥。所以在记录笔记时应该加入一些自己的理解，尽量精简概要，毕竟笔记这种东西，自己看着舒服就行。