Edit page

Search

Search allows users to search documents by name or tags. The search button is displayed inside the header bar.

Search

Config

Search

Inside doczrc.js file there is a themeConfig.search option to enable or disable search.

//doczrc.js
export default {
themeConfig: {
search: true,
},
};

Options

NameTypeDefaultDescription
searchbooleantrueSpecify if the search should be shown.

Tags

Tags are additional information inside each document that are searchable. They can be separated with commas.

---
name: Footer
route: /ui/footer
menu: UI
tags: ui, footer, footer config, theme, user interface
---
# My mdx file

Options

NameTypeDefaultDescription
tagsstringTags separated by commas or spaces.