create-vuepress-theme-plume 1.0.0-rc.164 → 1.0.0-rc.165

package/lib/index.js

@@ -13,7 +13,7 @@ import handlebars from "handlebars";
 import { osLocale } from "os-locale";
 
 //#region package.json
-var version = "1.0.0-rc.163";
+var version = "1.0.0-rc.164";
 
 //#endregion
 //#region src/constants.ts
@@ -244,8 +244,8 @@ async function generate(mode, data, cwd = process.cwd()) {
 			content: "shamefully-hoist=true\nshell-emulator=true"
 		});
 		if (data.packageManager === "yarn") {
-			const { output: output$1 } = await spawn("yarn", ["--version"]);
-			if (output$1.startsWith("2")) fileList.push({
+			const { output } = await spawn("yarn", ["--version"]);
+			if (output.startsWith("2")) fileList.push({
 				filepath: ".yarnrc.yml",
 				content: "nodeLinker: 'node-modules'\n"
 			});
@@ -278,8 +278,7 @@ async function generate(mode, data, cwd = process.cwd()) {
 	});
 	const ext = data.useTs ? "" : userPkg.type !== "module" ? ".mjs" : ".js";
 	const REG_EXT = /\.ts$/;
-	const output = mode === Mode.create ? path.join(cwd, data.root) : cwd;
-	await writeFiles(renderedFiles, output, (filepath) => {
+	await writeFiles(renderedFiles, mode === Mode.create ? path.join(cwd, data.root) : cwd, (filepath) => {
 		if (filepath.endsWith(".d.ts")) return filepath;
 		if (ext) return filepath.replace(REG_EXT, ext);
 		return filepath;
@@ -480,8 +479,7 @@ async function prompt(mode, root) {
 //#region src/run.ts
 async function run(mode, root) {
 	intro(colors.cyan("Welcome to VuePress and vuepress-theme-plume !"));
-	const result = await prompt(mode, root);
-	const data = resolveData(result, mode);
+	const data = resolveData(await prompt(mode, root), mode);
 	const progress = spinner();
 	progress.start(t("spinner.start"));
 	try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "create-vuepress-theme-plume",
   "type": "module",
-  "version": "1.0.0-rc.164",
+  "version": "1.0.0-rc.165",
   "description": "The cli for create vuepress-theme-plume's project",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo/)",
   "license": "MIT",
@@ -37,9 +37,9 @@
   },
   "plume-deps": {
     "vuepress": "2.0.0-rc.24",
-    "vue": "^3.5.21",
+    "vue": "^3.5.22",
     "http-server": "^14.1.1",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   },
   "scripts": {
     "build": "tsdown"

package/templates/.vuepress/collections.ts.handlebars

@@ -0,0 +1,124 @@
+/**
+ * @see https://theme-plume.vuejs.press/guide/collection/ 查看文档了解配置详情。
+ *
+ * Collections 配置文件，它在 `.vuepress/plume.config.{{#if useTs}}ts{{else}}js{{/if}}` 中被导入。
+ *
+ * 请注意，你应该先在这里配置好 Collections，然后再启动 vuepress，主题会在启动 vuepress 时，
+ * 读取这里配置的 Collections，然后在与 Collection 相关的 Markdown 文件中，自动生成 permalink。
+ *
+ * collection 的  type 为 `post` 时，表示为 文档列表类型（即没有侧边导航栏，有文档列表页）
+ * 可用于实现如 博客、专栏 等以文章列表聚合形式的文档集合 （内容相对碎片化的）
+ *
+ * collection 的 type 为 `doc` 时，表示为文档类型（即有侧边导航栏）
+ * 可用于实现如 笔记、知识库、文档等以侧边导航栏形式的文档集合 （内容强关联、成体系的）
+ * 如果发现 侧边栏没有显示，那么请检查你的配置是否正确，以及 Markdown 文件中的 permalink
+ * 是否是以对应的 Collection 配置的 link 的前缀开头。 是否展示侧边栏是根据 页面链接 的前缀 与 `collection.link`
+ * 的前缀是否匹配来决定。
+ */
+
+/**
+ * 在受支持的 IDE 中会智能提示配置项。
+ *
+ * - `defineCollections` 是用于定义 collection 集合的帮助函数
+ * - `defineCollection` 是用于定义单个 collection 配置的帮助函数
+ *
+ * 通过 `defineCollection` 定义的 collection 配置，应该填入 `defineCollections` 中
+ */
+import { defineCollection, defineCollections } from 'vuepress-theme-plume'
+
+{{#if multiLanguage}}
+{{#each locales}}
+/* =================== locale: {{ lang }} ======================= */
+
+const {{ prefix }}Blog = defineCollection({
+  // post 类型，这里用于实现 博客功能
+  type: 'post',
+  // 文档集合所在目录，相对于 `docs{{ path }}`
+  dir: 'blog',
+  // 文档标题，它将用于在页面的面包屑导航中显示
+  title: 'Blog',
+  // 文章列表页的链接，如果 `linkPrefix` 未定义，它也将作为 相关的文章的 permalink 的前缀
+  link: '/blog/',
+  //   linkPrefix: '/article/', // 相关文章的链接前缀
+  //   postList: true, // 是否启用文章列表页
+  //   tags: true, // 是否启用标签页
+  //   archives: true, // 是否启用归档页
+  //   categories: true, // 是否启用分类页
+  //   postCover: 'right', // 文章封面位置
+  //   pagination: 15, // 每页显示文章数量
+})
+
+const {{ prefix }}DemoDoc = defineCollection({
+  // doc 类型，该类型带有侧边栏
+  type: 'doc',
+  // 文档集合所在目录，相对于 `docs{{ path }}`
+  dir: 'demo',
+  // `dir` 所指向的目录中的所有 markdown 文件，其 permalink 需要以 `linkPrefix` 配置作为前缀
+  // 如果 前缀不一致，则无法生成侧边栏。
+  // 所以请确保  markdown 文件的 permalink 都以 `{{ path }}` + `linkPrefix` 开头
+  linkPrefix: '/demo',
+  // 文档标题，它将用于在页面的面包屑导航中显示
+  title: 'Demo',
+  // 手动配置侧边栏结构
+  sidebar: ['', 'foo', 'bar'],
+  // 根据文件结构自动生成侧边栏
+  // sidebar: 'auto',
+})
+
+/**
+ * 导出所有的 collections
+ *  ({{ prefix }}Blog 为博客示例，如果不需要博客功能，请删除)
+ *  ({{ prefix }}DemoDoc 为参考示例，如果不需要它，请删除)
+ */
+export const {{ prefix }}Collections = defineCollections([
+  {{ prefix }}Blog,
+  {{ prefix }}DemoDoc,
+])
+
+{{/each}}
+{{else}}
+const blog = defineCollection({
+  // post 类型，这里用于实现 博客功能
+  type: 'post',
+  // 文档集合所在目录，相对于 `docs{{ path }}`
+  dir: 'blog',
+  // 文档标题，它将用于在页面的面包屑导航中显示
+  title: 'Blog',
+  // 文章列表页的链接，如果 `linkPrefix` 未定义，它也将作为 相关的文章的 permalink 的前缀
+  link: '/blog/',
+  //   linkPrefix: '/article/', // 相关文章的链接前缀
+  //   postList: true, // 是否启用文章列表页
+  //   tags: true, // 是否启用标签页
+  //   archives: true, // 是否启用归档页
+  //   categories: true, // 是否启用分类页
+  //   postCover: 'right', // 文章封面位置
+  //   pagination: 15, // 每页显示文章数量
+})
+
+const demoDoc = defineCollection({
+  // doc 类型，该类型带有侧边栏
+  type: 'doc',
+  // 文档集合所在目录，相对于 `docs{{ path }}`
+  dir: 'demo',
+  // `dir` 所指向的目录中的所有 markdown 文件，其 permalink 需要以 `linkPrefix` 配置作为前缀
+  // 如果 前缀不一致，则无法生成侧边栏。
+  // 所以请确保  markdown 文件的 permalink 都以 `linkPrefix` 开头
+  linkPrefix: '/demo',
+  // 文档标题，它将用于在页面的面包屑导航中显示
+  title: 'Demo',
+  // 手动配置侧边栏结构
+  sidebar: ['', 'foo', 'bar'],
+  // 根据文件结构自动生成侧边栏
+  // sidebar: 'auto',
+})
+
+/**
+ * 导出所有的 collections
+ * (blog 为博客示例，如果不需要博客功能，请删除)
+ * (demoDoc 为参考示例，如果不需要它，请删除)
+ */
+export default defineCollection([
+  blog,
+  demoDoc,
+])
+{{/if}}

package/templates/.vuepress/config.ts.handlebars

@@ -54,23 +54,6 @@ export default defineUserConfig({
     // contributors: true,
     // changelog: false,
 
-    /**
-     * 博客
-     * @see https://theme-plume.vuejs.press/config/basic/#blog
-     */
-    // blog: false, // 禁用博客
-    // blog: {
-    //   postList: true, // 是否启用文章列表页
-    //   tags: true, // 是否启用标签页
-    //   archives: true, // 是否启用归档页
-    //   categories: true, // 是否启用分类页
-    //   postCover: 'right', // 文章封面位置
-    //   pagination: 15, // 每页显示文章数量
-    // },
-
-    /* 博客文章页面链接前缀 */
-    article: '/article/',
-
     /**
      * 编译缓存，加快编译速度
      * @see https://theme-plume.vuejs.press/config/basic/#cache
@@ -116,9 +99,9 @@ export default defineUserConfig({
     // readingTime: true,
 
     /**
-      * markdown
-      * @see https://theme-plume.vuejs.press/config/markdown/
-      */
+     * markdown
+     * @see https://theme-plume.vuejs.press/config/markdown/
+     */
     // markdown: {
     //   abbr: true,         // 启用 abbr 语法  *[label]: content
     //   annotation: true,   // 启用 annotation 语法  [+label]: content

package/templates/.vuepress/navbar.ts.handlebars

@@ -15,7 +15,7 @@ export const {{prefix}}Navbar = defineNavbarConfig([
   { text: '{{#if isEn}}Archives{{else}}归档{{/if}}', link: '{{ path }}blog/archives/' },
   {
     text: '{{#if isEn}}Notes{{else}}笔记{{/if}}',
-    items: [{ text: '{{#if isEn}}Demo{{else}}示例{{/if}}', link: '{{ path }}notes/demo/README.md' }]
+    items: [{ text: '{{#if isEn}}Demo{{else}}示例{{/if}}', link: '{{ path }}demo/README.md' }]
   },
 ])
 
@@ -28,7 +28,7 @@ export default defineNavbarConfig([
   { text: '{{#if isEn}}Archives{{else}}归档{{/if}}', link: '/blog/archives/' },
   {
     text: '{{#if isEn}}Notes{{else}}笔记{{/if}}',
-    items: [{ text: '{{#if isEn}}Demo{{else}}示例{{/if}}', link: '/notes/demo/README.md' }]
+    items: [{ text: '{{#if isEn}}Demo{{else}}示例{{/if}}', link: '/demo/README.md' }]
   },
 ])
 {{/if}}

package/templates/.vuepress/plume.config.ts.handlebars

@@ -12,11 +12,11 @@
 
 import { defineThemeConfig } from 'vuepress-theme-plume'
 {{#if multiLanguage}}
+import { enCollections, zhCollections } from './collections'
 import { enNavbar, zhNavbar } from './navbar'
-import { enNotes, zhNotes } from './notes'
 {{else}}
 import navbar from './navbar'
-import notes from './notes'
+import collections from './collections'
 {{/if}}
 
 /**
@@ -64,7 +64,7 @@ export default defineThemeConfig({
   },
 
   navbar,
-  notes,
+  collections,
 
   /**
    * 公告板
@@ -102,7 +102,7 @@ export default defineThemeConfig({
       },
 
       navbar: {{ prefix }}Navbar,
-      notes: {{ prefix }}Notes,
+      collections: {{ prefix }}Collections,
 
       /**
        * 公告板

package/templates/.vuepress/notes.ts.handlebars

@@ -1,75 +0,0 @@
-/**
- * @see https://theme-plume.vuejs.press/guide/document/ 查看文档了解配置详情。
- *
- * Notes 配置文件，它在 `.vuepress/plume.config.{{#if useTs}}ts{{else}}js{{/if}}` 中被导入。
- *
- * 请注意，你应该先在这里配置好 Notes，然后再启动 vuepress，主题会在启动 vuepress 时，
- * 读取这里配置的 Notes，然后在与 Note 相关的 Markdown 文件中，自动生成 permalink。
- *
- * 如果你发现 侧边栏没有显示，那么请检查你的配置是否正确，以及 Markdown 文件中的 permalink
- * 是否是以对应的 note 配置的 link 的前缀开头。 是否展示侧边栏是根据 页面链接 的前缀 与 `note.link`
- * 的前缀是否匹配来决定。
- */
-
-/**
- * 在受支持的 IDE 中会智能提示配置项。
- *
- * - `defineNoteConfig` 是用于定义单个 note 配置的帮助函数
- * - `defineNotesConfig` 是用于定义 notes 集合的帮助函数
- *
- * 通过 `defineNoteConfig` 定义的 note 配置，应该填入 `defineNotesConfig` 的 notes 数组中
- */
-import { defineNoteConfig, defineNotesConfig } from 'vuepress-theme-plume'
-
-{{#if multiLanguage}}
-{{#each locales}}
-/* =================== locale: {{ lang }} ======================= */
-
-const {{ prefix }}DemoNote = defineNoteConfig({
-  dir: 'demo',
-  // `dir` 所指向的目录中的所有 markdown 文件，其 permalink 需要以 `link` 配置作为前缀
-  // 如果 前缀不一致，则无法生成侧边栏。
-  // 所以请确保  markdown 文件的 permalink 都以 `link` 开头
-  link: '/demo',
-  // 手动配置侧边栏结构
-  sidebar: ['', 'foo', 'bar'],
-  // 根据文件结构自动生成侧边栏
-  // sidebar: 'auto',
-})
-
-/**
- * 导出所有的 note
- * 每一个 note 都应该填入到 `notes.notes` 数组中
- * （{{ prefix }}DemoNote 为参考示例，如果不需要它，请删除）
- */
-export const {{ prefix }}Notes = defineNotesConfig({
-  dir: '{{ removeLeadingSlash path }}notes',
-  link: '{{ path }}',
-  notes: [{{ prefix }}DemoNote],
-})
-
-{{/each}}
-{{else}}
-const demoNote = defineNoteConfig({
-  dir: 'demo',
-  // `dir` 所指向的目录中的所有 markdown 文件，其 permalink 需要以 `link` 配置作为前缀
-  // 如果 前缀不一致，则无法生成侧边栏。
-  // 所以请确保  markdown 文件的 permalink 都以 `link` 开头
-  link: '/demo',
-  // 手动配置侧边栏结构
-  sidebar: ['', 'foo', 'bar'],
-  // 根据文件结构自动生成侧边栏
-  // sidebar: 'auto',
-})
-
-/**
- * 导出所有的 note
- * 每一个 note 都应该填入到 `notes.notes` 数组中
- * （DemoNote 为参考示例，如果不需要它，请删除）
- */
-export default defineNotesConfig({
-  dir: 'notes',
-  link: '/',
-  notes: [demoNote],
-})
-{{/if}}