diff --git a/.vscode/settings.json b/.vscode/settings.json index db26feff..83eb7ffd 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -19,6 +19,7 @@ "cSpell.words": [ "bumpp", "caniuse", + "colours", "commitlint", "composables", "Docsearch", diff --git a/docs/package.json b/docs/package.json index 37403ba4..4ce66399 100644 --- a/docs/package.json +++ b/docs/package.json @@ -2,8 +2,8 @@ "name": "docs", "private": true, "scripts": { - "docs:build": "vuepress . build --clean-cache", - "docs:clean": "rimraf . .vuepress/.temp .vuepress/.cache .vuepress/dist", + "docs:build": "vuepress build --clean-cache", + "docs:clean": "rimraf .vuepress/.temp .vuepress/.cache .vuepress/dist", "docs:dev": "vuepress dev --clean-cache", "docs:serve": "anywhere -s -h localhost -d .vuepress/dist" }, diff --git a/packages/plugin-caniuse/src/shared/caniuse.ts b/packages/plugin-caniuse/src/shared/caniuse.ts index c5ee0860..65d37638 100644 --- a/packages/plugin-caniuse/src/shared/caniuse.ts +++ b/packages/plugin-caniuse/src/shared/caniuse.ts @@ -1,5 +1,15 @@ export type CanIUseMode = 'embed' | 'image' +/** + * can-i-use plugin options + */ export interface CanIUsePluginOptions { + /** + * 嵌入模式 + * + * embed 通过iframe嵌入,提供可交互视图 + * + * image 通过图片嵌入,静态 + */ mode: CanIUseMode } diff --git a/packages/theme/src/node/defaultLocaleOption.ts b/packages/theme/src/node/defaultLocaleOption.ts index ebb324df..42b76bfc 100644 --- a/packages/theme/src/node/defaultLocaleOption.ts +++ b/packages/theme/src/node/defaultLocaleOption.ts @@ -1,6 +1,7 @@ import type { PlumeThemeLocaleOptions } from '../shared' export const defaultLocaleOption: Partial = { + darkMode: true, home: { text: '首页', link: '/' }, article: '/article', tag: { text: '标签', link: '/tag' }, diff --git a/packages/theme/src/node/generateFrontmatter.ts b/packages/theme/src/node/generateFrontmatter.ts index b2b5a140..90dcc0e9 100644 --- a/packages/theme/src/node/generateFrontmatter.ts +++ b/packages/theme/src/node/generateFrontmatter.ts @@ -47,7 +47,7 @@ export const generateFrontmatter = ( file.startsWith(path.join(notesDir.replace(/^\//, ''), note.dir)) )) ) { - return currentNote.text + return currentNote.text || currentNote.dir } const basename = path.basename(filepath) if (isReadme(basename)) { diff --git a/packages/theme/src/node/index.ts b/packages/theme/src/node/index.ts index f2bb65f4..93e25c53 100644 --- a/packages/theme/src/node/index.ts +++ b/packages/theme/src/node/index.ts @@ -1,6 +1,18 @@ +import { + PlumeThemeNotesItem, + PlumeThemeNotesOptions, + PlumeThemeOptions, + PlumeThemeSidebarConfigOptions, +} from '../shared' import { themePlume } from './theme' export * from './theme' -export * from '../shared' export * from './define' +export { + PlumeThemeOptions, + PlumeThemeNotesOptions, + PlumeThemeNotesItem, + PlumeThemeSidebarConfigOptions, +} + export default themePlume diff --git a/readme.md b/readme.md index 75b43ba7..1dcf41db 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,16 @@ -## vuepress-theme-plume +## @vuepress-plume/vuepress-theme-plume -开发中 +一个简约的 vuepress 主题。 + +开箱即用,仅需少量配置即可使用。 + + +### [查看文档](https://pengzhanbo.cn/note/vuepress-theme-plume) + +### 注意 + +本主题基于 `VuePress2` ,仍处于 Beta 阶段。 + +这意味着功能尚未完善,在未来有概率发生破坏性更改。 + +本主题目前出于开发阶段中。