Markdown Enhance
Add align, sup/sub script, footnote, tasklist, tex, flowchart, diagram, mark and presentation support in Markdown
Slide Page
Adding slide pages to display things you like
Layout Enhancement
Adding breadcrumb, footer, improved navbar, improved page nav and etc.
Pageviews and Comments
Start pageview statistics and comment support with Waline
Article Information
Add author, writing date, reading time, word count and other information to your article
Blog Support
Listing your articles with their dates, tags and categories with some awesome layouts
Customizable Theme Color
Customize theme color
Dark Mode
Switch between light and dark modes freely
Full A11y support
Full support of accessibility in your site
Article Encryption
Encrypt you articles based on page links, so that only the one you want could see them
Search
Support docsearch and client search
Copy Code Blocks
Copy codes with one click in code blocks
Image Preview
Support viewing, zooming, sharing your page images like a gallery
SEO Enhancement
Optimize pages for search engines
Sitemap
Generate a Sitemap for your site
Feed
Generate feed to allow users to subscribe it
PWA
Make your site more like an APP
More New Features
Including icon support, fullscreen button, etc.
🛠Install
Create a new vuepress-theme-hope project in [dir] directory under the current path:
pnpm create vuepress-theme-hope [dir]
yarn create vuepress-theme-hope [dir]
npm init vuepress-theme-hope@latest [dir]
To add vuepress-theme-hope as docs builder to an existing project, run the following command in the project root directory:
pnpm create vuepress-theme-hope add [dir]
yarn create vuepress-theme-hope add [dir]
npm init vuepress-theme-hope@latest add [dir]
🚀Usage
import { defineUserConfig } from "vuepress";
import { hopeTheme } from "vuepress-theme-hope";
export default defineUserConfig({
theme: hopeTheme({
// your theme config here
}),
});
import { hopeTheme } from "vuepress-theme-hope";
export default {
theme: hopeTheme({
// your theme config here
}),
};