Catalog Page
Less than 1 minute
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 plugin.autoCatalog
to false
.
You can control this via plugin.autoCatalog
in the theme options, for example:
- Exclude some folders from catalog generation via
plugin.autoCatalog.exclude
- Control frontmatter generation through
plugin.autoCatalog.frontmatter
.
For detailed configuration, see Auto Catalog plugin docs.
Catalog Component
You can use the <AutoCatalog>
component directly in Markdown to display the catalog.
Homepage Catalog Demo
Catalog
<!-- Used to limit height -->
<div class="catalog-display-container">
<AutoCatalog base='/' />
</div>