From 0b616657ee07addcb220be93bb120fe86c6cf6e6 Mon Sep 17 00:00:00 2001
From: jimmyxuexue <65758455+Jimmylxue@users.noreply.github.com>
Date: Fri, 14 Oct 2022 23:33:56 +0800
Subject: [PATCH] docs: add html in footer example (#1487)
Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
---
docs/guide/theme-footer.md | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/docs/guide/theme-footer.md b/docs/guide/theme-footer.md
index 7ba14693..d59d0e1d 100644
--- a/docs/guide/theme-footer.md
+++ b/docs/guide/theme-footer.md
@@ -23,4 +23,17 @@ export interface Footer {
}
```
+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:
+
+```ts
+export default {
+ themeConfig: {
+ footer: {
+ message: 'Released under the MIT License.',
+ copyright: 'Copyright © 2019-present Evan You'
+ }
+ }
+}
+```
+
Note that footer will not be displayed when the [SideBar](./theme-sidebar) is visible.