mirror of https://github.com/vuejs/vitepress
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.5 KiB
1.5 KiB
Footer
VitePress will display global footer at the bottom of the page when themeConfig.footer is present.
export default {
themeConfig: {
footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2019-present Evan You'
}
}
}
export interface Footer {
// The message shown right before copyright.
message?: string
// The actual copyright text.
copyright?: string
// Whether to show the footer when the sidebar is visible.
showWithSidebar?: boolean
}
The above configuration also supports HTML strings. So, for example, if you want to configure footer text to have some links, you can adjust the configuration as follows:
export default {
themeConfig: {
footer: {
message: 'Released under the <a href="https://github.com/vuejs/vitepress/blob/main/LICENSE">MIT License</a>.',
copyright: 'Copyright © 2019-present <a href="https://github.com/yyx990803">Evan You</a>'
}
}
}
::: warning
Only inline elements can be used in message and copyright as they are rendered inside a <p> element. If you want to add block elements, consider using layout-bottom slot instead.
:::
By default, the footer will not be displayed when the SideBar is visible. But you can change this behavior by setting showWithSidebar to true in the configuration.
Frontmatter Config
This can be disabled per-page using the footer option on frontmatter:
---
footer: false
---