For full documentation visit mkdocs.org.
Commands
mkdocs new [dir-name]- Create a new project.mkdocs serve- Start the live-reloading docs server.mkdocs build- Build the documentation site.mkdocs -h- Print help message and exit.mkdocs gh-deploy- Deployment project.
Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
记录闲说
大数据的学习涉及多个组件。本文主要记录大数据学习过程中，涉及的各种组件技术以及其他相关技术。 其他技术包括学习过程中的一些查询记录。偶尔会写一点生活杂记。
mkdocs 是一个用于创建项目文档的快速，简单，完美华丽的静态站点生成器。
本文使用 mkdocs 搭建静态页面，并将其免费部署至 github上。技术详情详见：
https://initialdream16.github.io/mockdocsdemo/。
在免费部署至 github 时(将本地文档上传至 GitHub)，遇到以下问题：
remote: Support for password authentication was removed on August 13, 2021.
参考注意到：GitHub 将密码 换成了 token，因此，需要我们在setting中设置 token，上传代码至 github 时，输入 token即可。注意可以将 生成的 token 记录下来，每次提交时将其作为密码输入；或者可以将 token 直接添加到远程仓库链接中，这样就 避免了同一个仓库每次提交代码均瑶输入 token。
git remote set-url origin https://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@github.com/initialdream16/mockdocsdemo.git
其他
注意到在 github 上搭建 private 仓库，使用 github page 需要付费，这里将仓库改为 public。同时，在个人中心的 setting 中生成 token，并将该 token 写入远程仓库，因此可以满足多次提交一次输入 token(代替密码)。
静态页面的 github 部署
首先，进入 mkdocs 新建 项目目录下
git init
echo # xxx >> README.md
echo site/ >> .gitignore
git add README.md
git commit -m "first commit"
git remote add origin git@github.com:initialdream16/mkdocspagetest.git
git push -u origin master
mkdocs build
mkdocs gh-deploy # 发现远程仓库中新多了一个分支 gh-pages，且页面可同时访问
