使用mkdocs搭建文档系统(使用material主题美化)

material是一个mkdocs主题,它的优点:

  • 谷歌的material设计风格。

  • 渐进式布局,可以适配各种设备访问。

  • 支持非常多的插件和扩展,个人试过不少mkdocs主题,material的可扩展性是最好的。

安装

pip install mkdocs-material

在配置文件中添加:

theme:
	name: 'material'

配置

放一个我的配置文件:

theme:
    name: "material"
    logo:
        icon: "mkdocs"
    palette:
        primary: "black"
        accent: "deep orange"
    language: "zh"

主题名字

name属性就是主题的名字,我们使用的是material。

logo图标

logo会在网页的左上角显示出来,可以是一个文字或者是图片。

如果是图片可以用这样的形式:

theme:
  logo: 'images/logo.svg'

上面的例子mkdocs会在docs目录下搜索images的目录,所以前提是要你有这个文件。

调色盘

palette下有两个属性。

  • primary就是你主题的主色调,它会影响你的header,footer等等的背景色。
  • accent的颜色在你点击链接的时候就能看出来。
  • 具体效果,官方有个调色盘可以让你试验一下这些颜色的变化。

颜色的设置默认都是indigo颜色,其他颜色可供参考的选项:

Red Pink Purple Deep Purple Indigo Blue Light Blue Cyan Teal Green Light Green Lime Yellow Amber Orange Deep Orange Brown Grey Blue Grey Black White

最后的5种颜色不能用在accent上。

语言

language不用说。

很多mkdocs的主题到现在还不支持这个中文选项,material支持,但是其实没什么关系。

友情链接

extra:
  social:
    - type: 'github'
      link: 'https://github.com/squidfunk'
    - type: 'twitter'
      link: 'https://twitter.com/squidfunk'
    - type: 'linkedin'
      link: 'https://www.linkedin.com/in/squidfunk'

在extra的social属性可以定义友情链接。

  • 3
    点赞
  • 12
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
MkDocs是一个简单易用的静态网站生成器,它使用Markdown文件来创建漂亮的文档网站。虽然MkDocs本身并不是专门用于搭建博客的工具,但你可以通过使用MkDocs的插件和主题来实现博客功能。 有一个名为MkDocs Material Blog的主题可以用于创建类似博客的网站。这个主题是基于流行的MkDocs Material主题开发的,它添加了新的布局并自定义了一些样式。你可以克隆MkDocs Material Blog仓库,并运行初始化脚本来准备工作。 在MkDocs Material Blog主题中,你可以使用Markdown文件来编写博客的内容,并通过MkDocs生成静态网站。你可以根据需要自定义主题的样式,比如更改颜色等,可以参考MkDocs Material官方文档中有关更改颜色的指南来进行设置。 总结来说,你可以使用MkDocs搭建博客,通过使用MkDocs Material Blog主题和插件来实现博客功能,并根据需要自定义主题的样式。希望这些信息对你有帮助!<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *3* [【详细】使用MkDocs搭建个人博客网站](https://blog.csdn.net/weixin_45079659/article/details/127072423)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* [mkdocs-material-blog:用MkDocs的材料撰写博客](https://download.csdn.net/download/weixin_42140710/18593231)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

真实的hello world

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值