页脚支持

Mr.Hope ... 2021年2月27日 14:18 Layout
  • Footer
  • Layout
大约 2 分钟

vuepress-theme-hope 为所有页面提供了页脚功能支持页面配置

# 全局配置

在主题配置中,footer 字段用于全局配置页脚。你可以在 themeConfig 中设置 footer.contentfooter.copyright 全局设置默认的页脚内容与版权信息。

默认情况下页脚不会显示在页面中。如果希望每个页面都显示页脚,需要将 themeConfig.footer.display 设置为 true

# 页面配置

你可以在页面的 frontmatter 中配置 footercopyrightTextmedialink 字段,指定特定页面的页脚内容。

  • themeConfig.footer.displaytrue 时,你可以在 frontmatter 中将 footer 设置为 false 来禁用特定页面的页脚。

  • 当全局显示页脚未开启时,将 footer 设置为 true 会显示默认的页脚文字。

  • 如果你填入一个字符串,它会以 v-html 指令的形式插入到页脚的位置作为页脚的内容,所以你可以填入 HTMLString。

# copyrightText

copyrightText 字段用于设置特定页面的版权信息,它同样也支持 HTMLString (当你引用了文章且文章使用了特定许可的情况下很有用)。

当然在 themeConfig.footer.displaytrue 时,你也可以填入 false 来隐藏特定页面的版权信息。

该字段同 themeConfig.blog.links (具体配置见此),你可以在特定页面配置它以展示不同的社交媒体链接,你也可以填入 false 来隐藏它。

# 例子

  • 启用默认的页脚文字:

    ---
    footer: true
    ---
    
    1
    2
    3
  • 自定义页脚文字,同时不显示版权信息和媒体链接

    ---
    footer: This website is served by GitHub Pages
    copyrightText: false
    medialink: false
    ---
    
    1
    2
    3
    4
    5
  • 自定义页脚的内容和版权信息与媒体链接

    ---
    footer: <a href="https://github.com/Mister-Hope">Mr.Hope</a>
    copyrightText: MIT LICENSE
    medialink:
      Zhihu: https://zhihu.com
    ---
    
    1
    2
    3
    4
    5
    6
  • 当你在主题中设置了 footer.displaytrue 时,你还可以局部禁用它

    ---
    footer: false
    ---
    
    1
    2
    3
  • 如果你希望移除默认的 footer 内容同时保持社交媒体与版权信息显示,请传入一个空字符串。

    ---
    footer: ""
    ---
    
    1
    2
    3