MkDocs Material 安装部署和使用
MkDocs 是一个快速、简单、华丽的静态网站生成器,适用于构建项目文档。文档源文件以 Markdown 编写,并使用一个 YAML 文件来进行配置。Material for MkDocs 是 MkDocs 的一个主题配置,更加简洁美观,更新和维护也更加及时和频繁,且社区也更加活跃。
MkDocs 是一个快速、简单、华丽的静态网站生成器,适用于构建项目文档。文档源文件以 Markdown 编写,并使用一个 YAML 文件来进行配置。Material for MkDocs 是 MkDocs 的一个主题配置,更加简洁美观,更新和维护也更加及时和频繁,且社区也更加活跃。
Material for MkDocs 从 9.2.0 开始内置博客插件,内置博客插件添加了对从帖子文件夹构建博客的支持,这些帖子带有日期和其他结构化数据注释。
这个方法最开始是在 Linlin Yan (颜林林) 的 GitHub Pages 上第一次看到。后来,随着自己也用上了,就开始有了更深一些的认识。
看到 HelloGitHub 公众号在 2019-09-25 发表的这篇文章《和微信公众号编辑器战斗的日子》,结合自己最近折腾的 React 版本应用 Markdown2Html,也想着来聊几句。
向大家极力推荐这个插件:沉浸式双语网页翻译扩展,浏览器翻译神器,而且完全免费!
Elog (https://github.com/LetTTGACO/elog) —— 开放式跨平台博客解决方案,随意组合写作平台 (语雀/Notion/FlowUs) 和部署平台 (Hexo/Vitepress 等 。
GitHub Discussions 是一个可以在每个 GitHub 仓库上启用的论坛。它使开发者能够轻松地讨论新功能,从社区获得反馈,创建投票,发布公告等。这里搜集了一些基于 GitHub Discussions 的博客与站点,以供参考。
鉴于 MkDocs 的诸多优点,让它被很多知名开源项目选中,用于搭建和项目相关的文档网站。比如 Python 里知名的 Web 圈里的 django-rest-framework、FastAPI 以及基于 Go 编写的云网关代理服务器 traefik 等项目的官方文档站点,都是通过 MkDocs 进行搭建。