Guide
Tips
If you met a bug while using, you can open an issue here
Theme Features✨
The theme largely inherits the config of @vuepress/theme-default
, while adds a lot of functions and layout optimization on it.
Markdown Enhance
Added more syntax to Markdown, enriching documentation and blog writing:
- Custom Container
- Tabs
- Code Tabs
- Footnote
- Task list
- Image Enhancement
- Custom alignment
- Custom Attributes
- Subscript and Superscript
- Mark
- Chart
- ECharts
- FlowChart
- Tex Support
- Mermaid Diagram
- File include
- Code demo
- Presentation
- Stylize
- Playground
- Vue Playground
- Components out of box
- Customized Themes
Layout
New in Page:
Add TOC anchor on the right side under the desktop width
Layout Optimization:
Completely refactored mobile layout
Page navigation and page meta style improvements
Default homepage optimization:
- Features can have icons, links, and have a new outlook
- Widescreen layout optimization
Interface
Theme colors: allowing you to switch dynamically during browsing
Dark mode: allowing you to switch manually or apply automatically according to device settings
Page Enhance
Picture preview feature: supports zooming, dragging, sliding browsing, sharing and downloading
- Reading Counts
- Author and writing date
- Automatically generated word count and estimated reading time
- Tags and Categories
Blog
Advanced Features
Build-in Plugins🧩
The theme includes the following plugins, you can use them in other themes or directly.
- vuepress-plugin-auto-catalog: Catalog automatically generation for VuePress2
- vuepress-plugin-blog2: Blog plugin for VuePress2
- vuepress-plugin-comment2: Comment and pageviews
- vuepress-plugin-components: Provide some out of box plugins
- vuepress-plugin-copy-code2: Provide copy button for code blocks
- vuepress-plugin-copyright2: Append copyright information when copying or disable copy and selection.
- vuepress-plugin-feed2: Feed support
- vuepress-plugin-md-enhance: Provide more Markdown syntax
- vuepress-plugin-photo-swipe: Make the site's picture support click zoom
- vuepress-plugin-pwa2: Enhanced PWA support
- vuepress-plugin-reading-time2: Expect reading time and words count
- vuepress-plugin-sass-palette: Sass style plugin for all plugins and themes
- vuepress-plugin-seo2: SEO Enhancement Plugin
- vuepress-plugin-sitemap2: Sitemap plugin
Tips
Here are some other plugins that are not bundled by the theme, you can enable them according to your own needs.
- vuepress-plugin-lightgallery: Image preview plugin based on lightgallery
- vuepress-plugin-redirect: Redirect pages
- vuepress-plugin-remove-pwa: Plugins to remove pwa
- vuepress-plugin-search-pro: Client search plugin