Install / Usage
Less than 1 minute
Install
Create a new vuepress-theme-hope project in [dir]
folder:
pnpm create vuepress-theme-hope [dir]
npm init vuepress-theme-hope [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]
npm init vuepress-theme-hope add [dir]
Note
[dir]
is a parameter here, replace it with real folder names, such as docs
, blog
or other name you like.
Usage
Please import and use hopeTheme
to use vuepress-theme-hope
.
// .vuepress/config.ts
import { defineUserConfig } from "vuepress";
import { hopeTheme } from "vuepress-theme-hope";
export default defineUserConfig({
theme: hopeTheme({
// your theme config here
}),
});
// .vuepress/config.js
import { hopeTheme } from "vuepress-theme-hope";
export default {
theme: hopeTheme({
// your theme config here
}),
};
You can view Config of this site as an example.
Loading...