Skip to content

Commit

Permalink
feat: 全新的文档!
Browse files Browse the repository at this point in the history
  • Loading branch information
pengzhanbo committed Mar 8, 2024
1 parent 207efbd commit c56bae8
Show file tree
Hide file tree
Showing 65 changed files with 5,863 additions and 0 deletions.
Binary file added docs/.vuepress/public/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/favicon.ico
Binary file not shown.
Binary file added docs/.vuepress/public/images/blogger-avatar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/images/custom-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/images/custom-features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/images/custom-hero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/images/custom-profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/public/images/plume-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/public/images/plume-2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/public/images/plume-3.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/plume.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/.vuepress/public/plume.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/1.示例/加密文章.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 加密文章,密码:123456
author: pengzhanbo
createTime: 2023/12/25 01:28:29
permalink: /article/enx7c9s/
tags:
- 预览
- 标签
---

这是一篇 示例文章。

<!-- more -->

无内容。
15 changes: 15 additions & 0 deletions docs/1.示例/示例文章.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 示例文章
author: pengzhanbo
createTime: 2023/12/25 01:28:29
permalink: /article/xld23tu1/
tags:
- 预览
- 标签
---

这是一篇 示例文章。

<!-- more -->

无内容。
8 changes: 8 additions & 0 deletions docs/en/notes/theme/config/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Configuration
author: pengzhanbo
createTime: 2024/03/02 10:48:14
permalink: /en/config/intro/
---

Todo...
9 changes: 9 additions & 0 deletions docs/en/notes/theme/guide/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Theme Introduction
author: pengzhanbo
createTime: 2024/03/04 11:06:24
permalink: /en/guide/intro/
---


Todo...
112 changes: 112 additions & 0 deletions docs/notes/theme/config/frontmatter/basic.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
title: 通用配置
author: pengzhanbo
createTime: 2024/03/02 20:01:09
permalink: /config/frontmatter/basic/
---

## 概述

通用 Frontmatter 配置,适用于 所有的文章。

示例:

```md
---
title: 标题
author: 作者
createTime: 2024/03/02 20:01:09
permalink: /config/frontmatter/basic/
---
```

## 配置

### title

文章标题。

主题会在文件创建时,自动填充 当前文件名作为 文章标题。

### author

文章作者。

主题会在文件创建时,自动填充 `avatar.name || packageJson.author` 作为 文章作者。

### createTime

文章创建时间。

主题会在文件创建时,自动填充 当前时间作为 文章创建时间。

### permalink

文章永久链接。

主题会在文件创建时:

- 博客类型的文章,自动填充 `/article/` + `nanoid 生成的 6 位随机字符串` 作为 文章永久链接
- notes 目录下的文章,会根据 notes 的配置,自动填充 文章永久链接

### externalLink

- 类型: `boolean`
- 默认值: `true`

当前文章内的 外部链接是否显示 外部链接图标, 即 “ <ExternalLinkIcon /> ” 图标

### backToTop

- 类型: `boolean`
- 默认值: `true`

当前文章是否 显示 回到顶部 的按钮。

### comments

- 类型: `boolean`
- 默认值: `true`

当前文章是否 可评论。 仅在启用了评论功能的情况下生效。

### prev

- 类型: `string | { text: string, link: string, icon?: string }`
- 默认值: `''`

自定义当前文章的上一篇文章。

- 博客类型的文章,主题根据时间排序,自动填充上一篇文章的标题和链接。
- notes 类型的文章,主题根据 note sidebar 配置,自动填充上一篇文章的标题和链接。

### next

- 类型: `string | { text: string, link: string, icon?: string }`
- 默认值: `''`

自定义当前文章的下一篇文章。

- 博客类型的文章,主题根据时间排序,自动填充下一篇文章的标题和链接。
- notes 类型的文章,主题根据 note sidebar 配置,自动填充下一篇文章的标题和链接。

### lastUpdated

- 类型: `boolean`
- 默认值: `true`

当前文章是否 显示 最后更新时间。 最后更新时间 根据 git 提交时间自动填充。

### contributors

- 类型: `boolean`
- 默认值: `true`

当前文章是否 显示 贡献者。 贡献者 根据 git 提交者自动填充。

### editLink

- 类型: `boolean`
- 默认值: `true`

当前文章是否 显示 文章编辑 按钮。
75 changes: 75 additions & 0 deletions docs/notes/theme/config/frontmatter/friend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: 友情链接页
author: pengzhanbo
createTime: 2024/03/03 18:00:52
permalink: /config/frontmatter/friends/
---

## 概述

适用于友情链接页。

示例:

```md
---
friends: true
title: 友情链接
list:
-
name: pengzhanbo
link: https://github.com/pengzhanbo
avatar: https://github.com/pengzhanbo.png
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
---
```

## 配置

### friends

- 类型: `boolean`
- 默认值: `false`

当前页面是否为友情链接页。

### title

- 类型: `string`
- 默认值: `友情链接`

友情链接页的标题

### description

- 类型: `string`

友情链接页的描述

### list

- 类型: `FriendsItem[]`
- 默认值: `[]`

友情链接列表

```ts
interface FriendsItem {
/**
* 友情链接名
*/
name: string
/**
* 友情链接
*/
link: string
/**
* 友情链接头像
*/
avatar?: string
/**
* 友情链接描述
*/
desc?: string
}
```
59 changes: 59 additions & 0 deletions docs/notes/theme/config/frontmatter/home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: 首页
author: pengzhanbo
createTime: 2024/03/03 15:00:43
permalink: /config/frontmatter/home/
---

## 概述

仅适用于 首页。在 `{sourceDir}/README.md` 中进行配置。

示例:

```md
---
home: true
config:
- type: banner
- type: custom
---
```

## 配置

### home

- 类型: `boolean`

声明是否为 首页

### config

- 类型: `PlumeHomeConfig[]`

定义 首页 区域

```ts
interface PlumeHomeConfigBase {
/**
* 该区域的类型,根据类型应用不同的组件
*/
type: 'banner' | 'hero' | 'text-image' | 'image-text' | 'features' | 'profile' | 'custom' | string
/**
* 该区域是否占满全屏
*/
full?: boolean
/**
* 该区域的背景图片
* 你可以定义在 浅色/暗色 模式下的背景图片
*/
backgroundImage?: string | { light: string, dark: string }
/**
* 该区域的背景 定位方式
*/
backgroundAttachment?: 'fixed' | 'local'
}
```

更多详细配置请参考 [自定义首页](/guide/custom-home/)
46 changes: 46 additions & 0 deletions docs/notes/theme/config/frontmatter/post.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: 博客文章
author: pengzhanbo
createTime: 2024/03/03 11:01:03
permalink: /config/frontmatter/article/
---

## 概述

适用于 博客类型的文章。

示例:

```md
---
title: 文章标题
tags:
- tag1
- tag2
---
```

## 配置

### sticky

- 类型: `boolean \| number`
- 默认值: `false`

是否在文章列表中,置顶当前文章。

如果为 `number` ,则数字越大,文章置顶的位置越靠前。

### article

- 类型: `boolean`
- 默认值: `true`

是否在文章列表中,显示当前文章。

### tags

- 类型: `string[]`
- 默认值: `[]`

文章标签。
8 changes: 8 additions & 0 deletions docs/notes/theme/config/notes配置.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: notes配置
author: pengzhanbo
createTime: 2024/03/02 14:00:06
permalink: /config/notes/
---

Todo...
24 changes: 24 additions & 0 deletions docs/notes/theme/config/plugins/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: 介绍
author: Plume Theme
createTime: 2024/03/06 8:26:44
permalink: /config/plugins/
---

主题内置的使用的插件,扩展了主题的众多功能,你可以在这个 字段中, 实现对内部使用的各个插件的自定义配置。

## 配置

所有主题内部使用的插件, 均在 `plugins` 字段中进行配置。
``` js
import { plumeTheme } from 'vuepress-theme-plume'
import { defineUserConfig } from 'vuepress'

export default defineUserConfig({
theme: plumeTheme({
plugins: {
// more options... // [!code ++]
}
}),
})
```
Loading

0 comments on commit c56bae8

Please sign in to comment.