Footer

Mr.Hope ... February 27, 2021 14:18 Layout
  • Footer
  • Layout
About 1 min

vuepress-theme-hope provides footer feature for all pages Support page config.

# Global Config

In the themeConfig, footer field is used to config footer globally. You can set footer.content and footer.copyright in themeConfig to set the default footer content and copyright information globally.

The footer is not displayed on the page by default. To display the footer on every page, you need to set themeConfig.footer.display to true.

# Page Config

You can configure the footer, copyrightText and medialink fields in the frontmatter of the page to set footer content of a specific page.

  • When themeConfig.footer.display is true, you can set footer to false in frontmatter to disable the footer of a specific page.

  • When the global display of footer is not enabled, setting footer to true will display the default footer text.

  • If you fill in a string, it will be inserted into the footer as the content of the footer with v-html command, so you can fill in HTMLString.

# copyrightText

The copyrightText field is used to set the copyright information of a specific page. It also supports HTMLString (useful when you cite an article and the article uses a specific license).

When themeConfig.footer.display is true, you can also fill in false to hide the copyright information of a specific page.

This field is the same as themeConfig.blog.links (see here for specific configuration). You can configure it on a specific page to display different social media links. You can also fill in false to hide it.

# Example

  • Enable the default footer text:

    ---
    footer: true
    ---
    
    1
    2
    3
  • Customize footer text without displaying copyright information and media links:

    ---
    footer: This website is served by GitHub Pages
    copyrightText: false
    medialink: false
    ---
    
    1
    2
    3
    4
    5
  • Custom footer content and copyright information and media links:

    ---
    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
  • When you set footer.display to true in the theme, you can also disable it locally:

    ---
    footer: false
    ---
    
    1
    2
    3
  • To remove the default footer content while keeping social media and copyright information displayed, please use an empty string.

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