Catalog Page

VuePress Theme Hope provides catalog component and auto catalog generation using @vuepress/plugin-catalog.

Introduction

This feature is enabled by default. If there is no README.md in the folder, the theme will automatically generate a directory page for it. To disable, set plugins.catalog to false.

You can control this via plugins.catalog in the theme options, for example:

• Exclude some folders from catalog generation via plugins.catalog.exclude
• Control frontmatter generation through plugins.catalog.frontmatter.

For detailed configuration, see Catalog plugin docs.

Catalog Component

You can use the <Catalog> component directly in Markdown to display the catalog.

Homepage Catalog Demo

Catalog

• #Changelog

• #Config

  • #Config Intro
  • #I18n
  • #Style config
  • #Theme Config
    Theme Basic OptionsTheme Feature OptionsTheme Layout OptionsTheme Appearance OptionsTheme I18n OptionsTheme Behavior Options
  • #Plugin Config
    Theme PluginsMdEnhance Plugin ConfigBlog Plugin ConfigComment Plugin ConfigSearch Plugin ConfigCopyright Plugin ConfigFeed Plugin ConfigOther Plugin Config
  • #Frontmatter Config
    Info Frontmatter ConfigLayout Frontmatter ConfigPlugin Frontmatter ConfigHome Frontmatter ConfigBlog Home Frontmatter Config

• #Contribution Guide

• #Cookbook

  • #Markdown Introduction
    Markdown DEMOEmoji List
  • #About VuePress
    VuePress PageBuiltin Markdown featuresFile StructureVuePress ConfigPluginsTheme Config

• #Demos

  • #Blog Home
  • #Customized Blog Home
  • #Encryption Article (Password: 1234)
  • #Project Home with features
  • #Real Projects
  • #Slot Demo

• #FAQ

  • #Common question
  • #Vite FAQ
  • #Safari FAQ
  • #Troubleshooting
  • #Common Errors

• #Related Plugins

• #Get Started

  • #Runtime Setup
  • #Create Project
  • #Project Command
  • #Project Content
  • #Project Config
  • #Project Structure
  • #Project Deployment

• #Guide

  • #Theme Intro
    Theme introInstall / UsageMarkdown
  • #Interface
    A11yDarkmodeTheme ColorIcon supportCode ThemesResponsive LayoutOther featuresPure Mode
  • #Component
    Markdown to Vue SFCGlobal ComponentsComponentBuilt-in Components
  • #Markdown Enhance
    Enable EnhanceGrammarContentStylizeChartCodeOthersExternal import
  • #Layout
    NavBarSidebarPath NavigationFooterPageHome PageSlide
  • #Features
    Catalog PageCode CopyComment ServiceCopyrightEncryptionImage PreviewPage informationPage MetaSearch
  • #Blog
    Blog IntroBlogger InfoArticle ListCategory and tagsTimelineBlog homepageBlog Page Path
  • #Customize
    Customize colorCustomizing FontsCustomize EffectsCustomize LayoutsTheme PresetsExternal Scripts and Styles
  • #Advanced
    SEOSitemapPWAFeed SupportClient Config fileReplace ComponentsTheme Extending

• #V2 Migration

  • #V2 Highlights
  • #Config Migration Guide
  • #Page Migration Guide
  • #Style Migration Guide

<!-- Used to limit height -->
<div class="catalog-display-container">
  <Catalog base='/' />
</div>