mkdocs中更改material主题的页脚以使备案号链接到工信部网站

问题引入

在ICP备案成功后往往会收到如下通知

1
请您按照《非经营性互联网信息服务备案管理办法》要求 ,在您的网站首页底部中间位置,放置您的备案号并链接至"http://www.beian.miit.gov.cn/"。例如"京ICP备999999号"(此备案号为例子,请您一定更换成自己的备案号)。

当然,默认下mkdocs的material主题仅仅在yml中提供copyright的修改,并且无法在yml中设置超链接。(如果被查到没有链接至对应网站,可能会被罚款?)

工具

  • 脑子

步骤

首先我们要明白:mkdocs有如此强大的构建能力,是因为这个主题的很多文件已经被编辑好了,手册上的描述如下:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
.
├─ assets/
│  ├─ images/                          # Images and icons
│  ├─ javascripts/                     # JavaScript
│  └─ stylesheets/                     # Stylesheets
├─ partials/
│  ├─ integrations/                    # 3rd-party integrations
│  ├─ language/                        # Localized languages
│  ├─ footer.html                      # Footer bar
│  ├─ header.html                      # Header bar
│  ├─ hero.html                        # Hero teaser
│  ├─ language.html                    # Localized labels
│  ├─ nav-item.html                    # Main navigation item
│  ├─ nav.html                         # Main navigation
│  ├─ search.html                      # Search box
│  ├─ social.html                      # Social links
│  ├─ source.html                      # Repository information
│  ├─ tabs-item.html                   # Tabs navigation item
│  ├─ tabs.html                        # Tabs navigation
│  ├─ toc-item.html                    # Table of contents item
│  └─ toc.html                         # Table of contents
├─ 404.html                            # 404 error page
├─ base.html                           # Base template
└─ main.html                           # Default page

Note

注意那个footer.html,这个就是我们要修改的页脚,当然,html是很容易打开并修改的,重点是如何找到它

  • 以上文件被放在了之前使用pip install mkdocs-material命令安装的位置了,也就是python的库路径中下面我们开始操作

  • 找到mkdocs-material库的位置并打开

需要注意的是,material是mkdocs的一个主题,我们既然引用了它,那么修改默认主题的footer.html是没有用的,要找准material的页脚文件,我电脑的路径如下:

C:\Users\用户名\AppData\Local\Programs\Python\Python37\Lib\site-packages\material\partials

  1. 找到footer.html并打开

  2. 在为修改时,你会看到这样一行,它是将你在yml文件中修改的copyright引用到此处的意思:

1
{{ config.copyright }}
  1. 添加链接到工信部的超链接

  2. 将上面一行替换为(对,整行替换):

1
<a href="http://www.beian.miit.gov.cn/">{{ config.copyright }}</a>
  1. 其他的比如技术支持的链接当然也可以修改,但是因为确实是别人的劳动成果,最好保留mkdocsmaterial的链接哦

REFERENCE 参考文献

mkdocs-material官方文档

APPENDIX 附录

All the coding in this document is Available on the Github.

TTECH SUPPORT 技术支持

Edit at 2020 March 04