create-vuepress-theme-plume 1.0.0-rc.100

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

@@ -0,0 +1,90 @@
+import { defineUserConfig } from 'vuepress'
+import { {{ bundler }}Bundler } from '@vuepress/bundler-{{ bundler }}'
+import { plumeTheme } from 'vuepress-theme-plume'
+
+export default defineUserConfig({
+  base: '/',
+  lang: '{{ defaultLanguage }}',
+  {{#if multiLanguage}}
+  locales: {
+    {{#each locales}}
+    '{{ path }}': {
+      title: '{{ ../siteName }}',
+      lang: '{{ lang }}',
+      description: '{{ ../siteDescription }}',
+    },
+    {{/each}}
+  },
+  {{else}}
+  title: '{{ siteName }}',
+  description: '{{ siteDescription }}',
+  {{/if}}
+
+  bundler: {{ bundler }}Bundler(),
+
+  theme: plumeTheme({
+    // 添加您的部署域名
+    // hostname: 'https://your_site_url',
+
+    plugins: {
+      /**
+       * Shiki 代码高亮
+       * @see https://theme-plume.vuejs.press/config/plugins/code-highlight/
+       */
+      // shiki: {
+      //   languages: ['shell', 'bash', 'typescript', 'javascript'],
+      //   twoslash: true,
+      // },
+
+      /**
+       * markdown enhance
+       * @see https://theme-plume.vuejs.press/config/plugins/markdown-enhance/
+       */
+      markdownEnhance: {
+        demo: true,
+      //   include: true,
+      //   chart: true,
+      //   echarts: true,
+      //   mermaid: true,
+      //   flowchart: true,
+      },
+
+      /**
+       *  markdown power
+       * @see https://theme-plume.vuejs.press/config/plugin/markdown-power/
+       */
+      // markdownPower: {
+      //   pdf: true,
+      //   caniuse: true,
+      //   plot: true,
+      //   bilibili: true,
+      //   youtube: true,
+      //   icons: true,
+      //   codepen: true,
+      //   replit: true,
+      //   codeSandbox: true,
+      //   jsfiddle: true,
+      //   repl: {
+      //     go: true,
+      //     rust: true,
+      //     kotlin: true,
+      //   },
+      // },
+
+      /**
+       * comments
+       * @see https://theme-plume.vuejs.press/guide/features/comments/
+       */
+      // comment: {
+      //   provider: '', // "Artalk" | "Giscus" | "Twikoo" | "Waline"
+      //   comment: true,
+      //   repo: '',
+      //   repoId: '',
+      //   categoryId: '',
+      //   mapping: 'pathname',
+      //   reactionsEnabled: true,
+      //   inputPosition: 'top',
+      // },
+    },
+  }),
+})

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

@@ -0,0 +1,28 @@
+import { defineNavbarConfig } from 'vuepress-theme-plume'
+
+{{#if multiLanguage}}
+{{#each locales}}
+export const {{prefix}}Navbar = defineNavbarConfig([
+  { text: '{{#if isEn}}Home{{else}}首页{{/if}}', link: '{{ path }}' },
+  { text: '{{#if isEn}}Blog{{else}}博客{{/if}}', link: '{{ path }}blog/' },
+  { text: '{{#if isEn}}Tags{{else}}标签{{/if}}', link: '{{ path }}blog/tags/' },
+  { 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' }]
+  },
+])
+
+{{/each}}
+{{else}}
+export const navbar = defineNavbarConfig([
+  { text: '{{#if isEn}}Home{{else}}首页{{/if}}', link: '/' },
+  { text: '{{#if isEn}}Blog{{else}}博客{{/if}}', link: '/blog/' },
+  { text: '{{#if isEn}}Tags{{else}}标签{{/if}}', link: '/blog/tags/' },
+  { 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' }]
+  },
+])
+{{/if}}

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

@@ -0,0 +1,32 @@
+import { defineNoteConfig, defineNotesConfig } from 'vuepress-theme-plume'
+
+{{#if multiLanguage}}
+{{#each locales}}
+/* =================== locale: {{ lang }} ======================= */
+
+const {{ prefix }}DemoNote = defineNoteConfig({
+  dir: 'demo',
+  link: '/demo',
+  sidebar: ['', 'foo', 'bar'],
+})
+
+export const {{ prefix }}Notes = defineNotesConfig({
+  dir: '{{ removeLeadingSlash path }}notes',
+  link: '{{ path }}',
+  notes: [{{ prefix }}DemoNote],
+})
+
+{{/each}}
+{{else}}
+const demoNote = defineNoteConfig({
+  dir: 'demo',
+  link: '/demo',
+  sidebar: ['', 'foo', 'bar'],
+})
+
+export const notes = defineNotesConfig({
+  dir: 'notes',
+  link: '/',
+  notes: [demoNote],
+})
+{{/if}}

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

@@ -0,0 +1,57 @@
+import { defineThemeConfig } from 'vuepress-theme-plume'
+{{#if multiLanguage}}
+import { enNavbar, zhNavbar } from './navbar'
+import { enNotes, zhNotes } from './notes'
+{{else}}
+import { navbar } from './navbar'
+import { notes } from './notes'
+{{/if}}
+
+/**
+ * @see https://theme-plume.vuejs.press/config/basic/
+ */
+export default defineThemeConfig({
+  logo: 'https://theme-plume.vuejs.press/plume.png',
+  // your git repo url
+  docsRepo: '',
+  docsDir: '{{ docsDir }}',
+
+  appearance: true,
+
+  {{#unless multiLanguage}}
+  profile: {
+    avatar: 'https://theme-plume.vuejs.press/plume.png',
+    name: '{{ siteName }}',
+    description: '{{ siteDescription }}',
+    // circle: true,
+    // location: '',
+    // organization: '',
+  },
+
+  navbar,
+  notes,
+  {{/unless}}
+  social: [
+    { icon: 'github', link: '/' },
+  ],
+
+  {{#if multiLanguage}}
+  locales: {
+    {{#each locales}}
+    '{{ path }}': {
+      profile: {
+        avatar: 'https://theme-plume.vuejs.press/plume.png',
+        name: '{{ ../siteName }}',
+        description: '{{ ../siteDescription }}',
+        // circle: true,
+        // location: '',
+        // organization: '',
+      },
+
+      navbar: {{ prefix }}Navbar,
+      notes: {{ prefix }}Notes,
+    },
+    {{/each}}
+  },
+  {{/if}}
+})

package/templates/.vuepress/public/plume.svg

@@ -0,0 +1,8 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" viewBox="0 0 72 72">
+	<path fill="#5086a1" d="M42.334 49.147a29.945 29.945 0 0 1-19.338-8.151c-8.014-7.365-8.378-18.076-8.533-22.649l-.022-.627a2.904 2.904 0 0 1 3.457-2.951c17.005 3.355 21.695 16.324 22.056 17.4a49.543 49.543 0 0 1 3.574 15.922a1 1 0 0 1-.967 1.052c-.029.001-.106.004-.227.004" />
+	<path fill="#8cccd5" d="M44.436 55.316c-11.646 0-17.376-6.974-17.653-7.354a1 1 0 0 1 .262-1.424a11.103 11.103 0 0 1 12.774-1.574c-1.465-9.078 1.877-13.568 2.031-13.77a.998.998 0 0 1 .75-.39a.97.97 0 0 1 .78.325c8.944 9.771 8.793 16.532 7.908 19.691c-.034.14-1.062 4.092-4.772 4.406c-.711.062-1.405.09-2.08.09" />
+	<g fill="none" stroke="#333" stroke-linecap="round" stroke-linejoin="round" stroke-width="1">
+		<path d="M55.184 57.69S34.96 45.877 23.097 24.206m22.131 30.096c-11.93.46-17.628-6.88-17.628-6.88" />
+		<path d="M40.528 42.483c-.56-7.195 2.116-10.679 2.116-10.679c8.834 9.654 8.406 16.162 7.681 18.747m-13.311-3.129a30.15 30.15 0 0 1-13.341-7.162c-8.072-7.419-8.067-18.241-8.232-22.577a1.903 1.903 0 0 1 2.264-1.932C34.694 19.103 39.02 32.528 39.02 32.528" />
+	</g>
+</svg>

package/templates/.vuepress/theme/components/Custom.vue

@@ -0,0 +1,11 @@
+<script setup lang="ts">
+import { ref } from 'vue'
+
+const message = ref('Hello World!')
+</script>
+
+<template>
+  <div class="my-custom-content">
+    {{ message }}
+  </div>
+</template>

package/templates/.vuepress/theme/shim.d.ts

@@ -0,0 +1,6 @@
+declare module '*.vue' {
+  import type { ComponentOptions } from 'vue'
+
+  const comp: ComponentOptions
+  export default comp
+}

package/templates/.vuepress/theme/styles/custom.css

@@ -0,0 +1,50 @@
+:root {
+  /** 主题颜色 */
+
+  /*
+  --vp-c-brand-1: #5086a1;
+  --vp-c-brand-2: #6aa1b7;
+  --vp-c-brand-3: #8cccd5;
+  --vp-c-brand-soft: rgba(131, 208, 218, 0.314);
+  */
+
+  /** 背景颜色 */
+
+  /*
+  --vp-c-bg: #fff;
+  --vp-c-bg-alt: #f6f6f7;
+  --vp-c-bg-elv: #fff;
+  --vp-c-bg-soft: #f6f6f7;
+  */
+
+  /** 文本颜色 */
+
+  /*
+  --vp-c-text-1: rgba(60, 60, 67);
+  --vp-c-text-2: rgba(60, 60, 67, 0.78);
+  --vp-c-text-3: rgba(60, 60, 67, 0.56);
+  */
+}
+
+/** 深色模式 */
+.dark {
+  /*
+  --vp-c-brand-1: #8cccd5;
+  --vp-c-brand-2: #6aa1b7;
+  --vp-c-brand-3: #5086a1;
+  --vp-c-brand-soft: rgba(131, 208, 218, 0.314);
+  */
+
+  /*
+  --vp-c-bg: #1b1b1f;
+  --vp-c-bg-alt: #161618;
+  --vp-c-bg-elv: #202127;
+  --vp-c-bg-soft: #202127;
+  */
+
+  /*
+  --vp-c-text-1: rgba(255, 255, 245, 0.86);
+  --vp-c-text-2: rgba(235, 235, 245, 0.6);
+  --vp-c-text-3: rgba(235, 235, 245, 0.38);
+  */
+}

package/templates/common/README.md.handlebars

@@ -0,0 +1,57 @@
+# {{ name }}
+
+The Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
+
+## Install
+
+```sh
+{{#if (equal packageManager "pnpm")}}
+pnpm i
+{{else if (equal packageManager "yarn")}}
+yarn
+{{else}}
+npm i
+{{/if}}
+```
+
+## Usage
+
+{{#if (equal packageManager "pnpm")}}
+```sh
+# start dev server
+pnpm docs:dev
+# build for production
+pnpm docs:build
+# preview production build in local
+pnpm docs:preview
+# update vuepress and theme
+pnpm vp-update
+```
+{{else if (equal packageManager "yarn")}}
+```sh
+# start dev server
+yarn docs:dev
+# build for production
+yarn docs:build
+# preview production build in local
+yarn docs:preview
+# update vuepress and theme
+yarn vp-update
+```
+{{else}}
+```sh
+# start dev server
+npm run docs:dev
+# build for production
+npm run docs:build
+# preview production build in local
+npm run docs:preview
+# update vuepress and theme
+npm run vp-update
+```
+{{/if}}
+
+## Documents
+
+- [vuepress](https://vuepress.vuejs.org/)
+- [vuepress-theme-plume](https://theme-plume.vuejs.press/)

package/templates/common/README.zh-CN.md.handlebars

@@ -0,0 +1,57 @@
+# {{ name }}
+
+网站使用 [vuepress](https://vuepress.vuejs.org/) 和 [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) 构建生成。
+
+## Install
+
+```sh
+{{#if (equal packageManager "pnpm")}}
+pnpm i
+{{else if (equal packageManager "yarn")}}
+yarn
+{{else}}
+npm i
+{{/if}}
+```
+
+## Usage
+
+{{#if (equal packageManager "pnpm")}}
+```sh
+# 启动开发服务
+pnpm docs:dev
+# 构建生产包
+pnpm docs:build
+# 本地预览生产服务
+pnpm docs:preview
+# 更新 vuepress 和主题
+pnpm vp-update
+```
+{{else if (equal packageManager "yarn")}}
+```sh
+# 启动开发服务
+yarn docs:dev
+# 构建生产包
+yarn docs:build
+# 本地预览生产服务
+yarn docs:preview
+# update vuepress and theme
+yarn vp-update
+```
+{{else}}
+```sh
+# 启动开发服务
+npm run docs:dev
+# 构建生产包
+npm run docs:build
+# 本地预览生产服务
+npm run docs:preview
+# 更新 vuepress 和主题
+npm run vp-update
+```
+{{/if}}
+
+## 文档
+
+- [vuepress](https://vuepress.vuejs.org/)
+- [vuepress-theme-plume](https://theme-plume.vuejs.press/)

package/templates/deploy/github/.github/workflows/deploy.yml.handlebars

@@ -0,0 +1,79 @@
+name: deploy
+
+on:
+  # 每当 push 到 main 分支时触发部署
+  # Deployment is triggered whenever a push is made to the main branch.
+  push:
+    branches: [main]
+  # 手动触发部署
+  # Manually trigger deployment
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # “最近更新时间” 等 git 日志相关信息，需要拉取全部提交记录
+          # "Last updated time" and other git log-related information require fetching all commit records.
+          fetch-depth: 0
+
+{{#if (equal packageManager "pnpm")}}
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+{{/if}}
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          # 选择要使用的 node 版本
+          node-version: 20
+
+{{#if (equal packageManager "npm")}}
+      # 安装依赖
+      # Install dependencies
+      - name: Install Dependencies
+        run: npm ci
+{{/if}}
+
+{{#if (equal packageManager "pnpm")}}
+      # 安装依赖
+      # Install dependencies
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+{{/if}}
+
+{{#if (equal packageManager "yarn")}}
+      - name: Run install
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: install
+{{/if}}
+
+      # 运行构建脚本
+      # Run the build script
+{{#unless (equal packageManager "yarn")}}
+      - name: Build VuePress site
+        run: {{packageManager}} run docs:build
+{{/unless}}
+{{#if (equal packageManager "yarn")}}
+      - name: Build VuePress site
+        uses: borales/actions-yarn@v4
+        with:
+          cmd: docs:build
+{{/if}}
+
+
+      # 查看 workflow 的文档来获取更多信息
+      # @see https://github.com/crazy-max/ghaction-github-pages
+      - name: Deploy to GitHub Pages
+        uses: crazy-max/ghaction-github-pages@v4
+        with:
+          # 部署到 gh-pages 分支
+          target_branch: gh-pages
+          # 部署目录为 VuePress 的默认输出目录
+          build_dir: {{docsDir}}/.vuepress/dist
+        env:
+          # @see https://docs.github.com/cn/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
+          GITHUB_TOKEN: $\{{ secrets.GITHUB_TOKEN }}

package/templates/deploy/netlify/netlify.toml.handlebars

@@ -0,0 +1,9 @@
+# prevent Netlify npm install
+
+[build]
+publish = "{{ docsDir }}/.vuepress/dist"
+command = "{{#if (equal packageManager 'yarn')}}yarn && yarn{{else}}{{packageManager}} run{{/if}} docs:build"
+
+[build.environment]
+NODE_VERSION = "20"
+NPM_FLAGS = "--version"

package/templates/deploy/vercel/vercel.json.handlebars

@@ -0,0 +1,6 @@
+{
+  "framework": null,
+  "buildCommand": "{{#if (equal packageManager 'yarn')}}yarn{{else}}{{packageManager}} run{{/if}} docs:build",
+  "installCommand": "{{#if (equal packageManager 'yarn')}}yarn{{else}}{{packageManager}} install{{/if}}",
+  "outputDirectory": "{{ docsDir }}/.vuepress/dist"
+}

package/templates/docs/en/README.md.handlebars

@@ -0,0 +1,22 @@
+---
+pageLayout: home
+externalLinkIcon: false
+config:
+  -
+    type: hero
+    full: true
+    background: tint-plate
+    hero:
+      name: Theme Plume
+      tagline: VuePress Next Theme
+      text: A simple, feature-rich, document & blog
+      actions:
+        -
+          theme: brand
+          text: Blog
+          link: {{#if (equal defaultLanguage 'en-US')}}/{{else}}/en/{{/if}}blog/
+        -
+          theme: alt
+          text: Github →
+          link: https://github.com/pengzhanbo/vuepress-theme-plume
+---

package/templates/docs/en/notes/demo/README.md

@@ -0,0 +1,6 @@
+---
+title: Demo
+---
+
+- [bar](./bar.md)
+- [foo](./foo.md)

package/templates/docs/en/notes/demo/bar.md

@@ -0,0 +1,5 @@
+---
+title: bar
+---
+
+[foo](./foo.md)

package/templates/docs/en/notes/demo/foo.md

@@ -0,0 +1,5 @@
+---
+title: foo
+---
+
+[bar](./bar.md)

package/templates/docs/en/preview/custom-component.example.md

@@ -0,0 +1,8 @@
+---
+title: Custom Component
+tags:
+  - preview
+  - component
+---
+
+<CustomComponent />