chore: document sidebarTitle frontmatter (#3482)

* chore: document sidebarTitle frontmatter * spacing * Update docs/pages/docs/docs-theme/theme-configuration.mdx Co-authored-by: Dimitri POSTOLOV <[email protected]> * Update docs/pages/docs/docs-theme/theme-configuration.mdx * Apply suggestions from code review * aa --------- Co-authored-by: Dimitri POSTOLOV <[email protected]>
shuding · Oct 17, 2024 · 2fe8e71 · 2fe8e71
1 parent ef39f6d
commit 2fe8e71
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/pages/docs/docs-theme/theme-configuration.mdx b/docs/pages/docs/docs-theme/theme-configuration.mdx
@@ -403,6 +403,24 @@ export default {
 
 <Screenshot src={sidebarTitleComponentImage} alt="Customized Sidebar" />
 
+### Customize Sidebar with Frontmatter
+
+In addition, you can customize the sidebar title using the `sidebarTitle`
+property in your front matter:
+
+```mdx filename="pages/getting-started.mdx"
+---
+sidebarTitle: Getting Started 🚀
+---
+```
+
+The priority of the sidebar title is as follows:
+
+1. `title` property from `_meta.js` file
+1. Front matter `sidebarTitle`
+1. Front matter `title`
+1. Filename of the page formatted with [Title](https://title.sh)
+
 ## Content
 
 ### MDX Components