pp/custom-vitepress-theme
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: 添加展示图片

Browse Source
This commit is contained in:
ppst
2023-06-15 12:38:29 +08:00
parent 004d027777
commit 1a31d01764
2 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@@ -1,25 +1,33 @@
# vitepress 自定义主题 # vitepress 自定义主题
可以直接克隆，也可以使用下面方法一步步自定义实现 可以直接克隆，也可以使用下面方法一步步自定义实现
## 克隆demo项目
克隆地址 克隆地址
```shell ```shell
git clone http://git.ppst.top/pp/custom-vitepress-theme-demo.git http://git.ppst.top/pp/custom-vitepress-theme-demo
``` ```
## 安装 vitepress ## 展示
![首页](http://img.ppst.top/custom-vitepress-theme/custom-vitepress-theme/1.png)
![归档](http://img.ppst.top/custom-vitepress-theme/custom-vitepress-theme/2.png)
![搜索](http://img.ppst.top/custom-vitepress-theme/custom-vitepress-theme/3.png)
![分类](http://img.ppst.top/custom-vitepress-theme/custom-vitepress-theme/4.png)
![黑夜模式](http://img.ppst.top/custom-vitepress-theme/custom-vitepress-theme/5.png)
## 自定义使用
### 安装 vitepress
```shell ```shell
pnpm install vitepress pnpm install vitepress
``` ```
## 安装主题 ### 安装主题
```shell ```shell
pnpm install custom-vitepress-theme pnpm install custom-vitepress-theme
``` ```
## 安装读取文档插件 ### 安装读取文档插件
```shell ```shell
pnpm install markdown-from-posts pnpm install markdown-from-posts
``` ```
## 目录结构 ### 目录结构
```md ```md
.vitepress .vitepress
@@ -37,7 +45,7 @@ public
index.md index.md
``` ```
### .vitepress文件夹 #### .vitepress文件夹
config.ts - 配置自定义vitepress导航以及标题等 config.ts - 配置自定义vitepress导航以及标题等

2
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "custom-vitepress-theme", "name": "custom-vitepress-theme",
"version": "0.0.1", "version": "0.0.2",
"description": "自定义vitepress主题", "description": "自定义vitepress主题",
"main": "src/index.ts", "main": "src/index.ts",
"exports": { "exports": {