使用MkDocs 管理博客

需求

  • MarkDown 文本
  • 文档结构化,方便组织
  • 搜索整理
  • shell 编辑
  • 随时随地编辑

MkDocs 优点

  • 轻量简单 :想用HEXO,但是NodeJS安装不上,费事费力
  • 方面客户化: Python包,修改简单

方案

  • 内部服务器 稳定,但是访问困难
  • Home Raspberry
  • 发布到Github Page

试验环境

  • 安装环境Centos6

官方网站

pip install mkdocs
# 创建笔记项目
mkdocs new mdnote
cd mdnote
  • 模板
pip install mkdocs-bootswatch

可用的模板:

  • amelia
  • cerulean
  • cosmo
  • cyborg
  • flatly
  • journal
  • readable
  • simplex
  • slate
  • spacelab
  • united
  • yeti

  • 设置

编辑mkdocs.yml

site_name: iKnow
theme: readthedocs
  • 文件存放目录
docs/
    index.md
    user-guide/getting-started.md
    user-guide/configuration-options.md
    about.md
  • 部署到Github Page
    生成静态页面: mkdocs build
    生成的目录在site下,发布到自己的Github Page项目里
    部署后遇到的问题:
unable to build page. Please try again later.

解决方法:
必须建立一个README.MD文件,添加后build正常

你可能感兴趣的:(使用MkDocs 管理博客)