Description
A vuepress theme with tons of features✨
Add align, sup/sub script, footnote, tasklist, tex, flowchart, diagram, mark and presentation support in markdown
Start pageview statistics and comment support with Waline and Vssue
Add author, writing date, reading time, word count and other information to your article
Add date, tags and category to your articles, then article, tag, category and timeline list will be auto generated
Encrypt you article based on path and folders, so that only the one you want could see them
Supports custom theme colors and allows users to switch between preset theme colors
Switch between light and dark modes freely
Optimize pages for search engines.
Generate a Sitemap for your website
You can generate feed, and let users to subcribe it
The built-in PWA plugin will make your website more like an APP.
Turn on TypeScript support for your VuePress
Including icon support, path navigation, footer support, fullscreen button, blog homepage, etc.
Create a vuepress-theme-hope project in [dir]
folder under the current project:
yarn create vuepress-theme-hope [dir]
npm init vuepress-theme-hope [dir]
// .vuepress/config.ts
import theme from "vuepress-theme-hope";
export default theme.config({
// your config here
});
// .vuepress/config.js
const { config } = require("vuepress-theme-hope");
module.exports = config({
// your config here
});
Tips
config
is just a helper function, it will give you config description and provide auto-completion through TS’s Interface and JSDoc.
At the same time, the config
function will also complete some default configurations for your current configuration which will pass directly to VuePress. Don’t worry it will change your config! It will respect every config you make to make sure your other plugins work well.
We are also providing themeConfig
, navbarConfig
and sidebarConfig
helper to provide similar experience in case you split your config in to several files.
You can view Config of this site (opens new window) as an example.
This app can be installed on your PC or mobile device. This will allow this web app to look and behave like any other installed app. You will find it in your app lists and be able to pin it to your home screen, start menus or task bars. This installed web app will also be able to safely interact with other apps and your operating system.
A vuepress theme with tons of features✨
We welcome you to switch to "Next" tag using the V2 version of the theme based on VuePress2.
The V2 version has been completely refactored, with richer functions and better outlook. The theme is based on Vue3, built with Vite by default, and the performance and startup speed have been greatly improved!"