曂沅仴駦 发表于 2024-5-22 05:02:29

MkDocs+Github搭建个人博客

写在前面

在实验过Hugo、Jekyll等博客框架后,我最终选择了MkDocs+Github的方案,主要出于以下几点考虑:

[*]博客内容可基于Markdown写作,不需要掌握html等别的语法。
[*]发布简单,只需几个命令就可以摆设好本地框架,更新也很方便。
[*]页面简洁,大概对追求美观的用户而言还有提升空间,但对我完全充足了。

本博客所需底子:

[*]markdown语法
[*]命令行操作
[*]python情况
[*]github利用

什么是MkDocs

MkDocs是一个静态网站生成器,它专门为构建项目文档而设计。它的焦点优势在于速度、简单性和美观度。想象一下,你有一个项目,需要为它创建文档,而MkDocs能帮你轻松搞定这统统。

[*]官网所在:https://www.mkdocs.org/
[*]新手教程:https://www.mkdocs.org/getting-started/
[*]用户手册:https://www.mkdocs.org/user-guide/

搭建本地页面

安装

首先,请确保你的电脑已安装python情况,之后就可以基于pip安装mkdocs:
pip install mkdocs接下来运行mkdocs --version确认安装是否成功。
创建站点

运行以下命令:(dir_name可以自由命名)
mkdocs new dir_name这行命令将会在当前目次下创建一个新文件夹dir_name,文件夹中包罗:

[*]子目次docs: 博客的焦点内容(.md文件)就包含在此目次下
[*]设置文件mkdocs.yml:暂时不用动它
然后进入dir_name文件夹,运行mkdocs serve,命令行中会表现Serving on http://...,即可在本地访问该站点。
设置文件修改

可以通过编辑mkdocs.yml来修改页面格式,示比方下:
site_name: Elsy's Blog
theme:
      name: readthedocs
nav:
      - 主页: index.md   
      - 关于: aboutme.md
利用Github发布在线网页


[*]在dir_name下运行mkdocs build,这会生成一个新文件夹site,其中包含了静态站点的页面内容。
[*]在Github上新建一个仓库。
[*]将本地dir_name文件夹与Github新建仓库连接。
[*]在dir_name下运行mkdocs gh-deploy,成功运行后命令行会表现"Your documentation should shortly be available at : ..."
网络不好时大概需要多运行反复,而且很大概有点延迟2333

[*]更新网页:在本地docs文件夹下编辑完md文档后,命令行中执行mkdocs gh-deploy即可


版权声明:本文接纳知识共享 4.0 许可证 (署名-非贸易性利用-克制演绎)

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
页: [1]
查看完整版本: MkDocs+Github搭建个人博客