@sugarat/create-theme 0.0.28 → 0.0.30

package/README.md

@@ -26,7 +26,7 @@ $ pnpm create @sugarat/theme
 With Bun:
 
 ```bash
-$ bunx @sugarat/create-theme --bun
+$ bun create @sugarat/theme
 ```
 
 Then follow the prompts!
@@ -44,5 +44,5 @@ yarn create @sugarat/theme my-first-blog
 pnpm create @sugarat/theme my-first-blog
 
 # bun
-bunx @sugarat/create-theme my-first-blog --bun
+bun create @sugarat/theme my-first-blog
 ```

package/dist/index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
-var h=Object.create;var f=Object.defineProperty;var w=Object.getOwnPropertyDescriptor;var v=Object.getOwnPropertyNames;var y=Object.getPrototypeOf,_=Object.prototype.hasOwnProperty;var N=(o,n,e,a)=>{if(n&&typeof n=="object"||typeof n=="function")for(let c of v(n))!_.call(o,c)&&c!==e&&f(o,c,{get:()=>n[c],enumerable:!(a=w(n,c))||a.enumerable});return o};var u=(o,n,e)=>(e=o!=null?h(y(o)):{},N(n||!o||!o.__esModule?f(e,"default",{value:o,enumerable:!0}):e,o));var j=(o,n,e)=>new Promise((a,c)=>{var r=l=>{try{m(e.next(l))}catch(p){c(p)}},s=l=>{try{m(e.throw(l))}catch(p){c(p)}},m=l=>l.done?a(l.value):Promise.resolve(l.value).then(r,s);m((e=e.apply(o,n)).next())});var t=u(require("path")),b=u(require("process")),g=u(require("fs-extra"));var $=b.default.argv.slice(2),k=$.filter(o=>o.startsWith("--")),d=$.filter(o=>!o.startsWith("--")),F=d[d.length-1]||"my-blog",i=k.includes("--bun");function O(o){let n=t.default.join(__dirname,"template");g.default.copy(n,o,e=>j(this,null,function*(){yield g.default.copy(t.default.join(__dirname,"move/gitignore"),t.default.join(o,".gitignore"));let a=i?"bunfig.toml":"npmrc",c=i?"bunfig.toml":".npmrc";if(yield g.default.copy(t.default.join(__dirname,`move/${a}`),t.default.join(o,c)),i){let r=t.default.join(o,"package.json"),s=yield g.default.readJSON(r);s.scripts.build=`NODE_ENV=production ${s.scripts.build}`,yield g.default.writeJSON(r,s,{spaces:2})}if(e)console.error("An error occurred while copying template files:",e);else{console.log("\u{1F389} \u{1F389} created successfully!"),console.log(),console.log(`project in ${o}`),console.log();let r=i?"bun":"pnpm",s=`Done. Now run:
-
-  \u2460  cd ${t.default.parse(o).name}
-  \u2461  ${r} install
-  \u2462  ${r} run ${i?"--bun ":""}dev
-  \u2463  ${r} run ${i?"--bun ":""}build
-  \u2464  ${r} run ${i?"--bun ":""}serve`;console.log(s)}}))}console.log("Creating @sugarat/theme project...");console.log();O(t.default.join(b.default.cwd(),F));
+var k=Object.create;var j=Object.defineProperty;var v=Object.getOwnPropertyDescriptor;var h=Object.getOwnPropertyNames;var w=Object.getPrototypeOf,y=Object.prototype.hasOwnProperty;var N=(o,e,n,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of h(e))!y.call(o,r)&&r!==n&&j(o,r,{get:()=>e[r],enumerable:!(s=v(e,r))||s.enumerable});return o};var d=(o,e,n)=>(n=o!=null?k(w(o)):{},N(e||!o||!o.__esModule?j(n,"default",{value:o,enumerable:!0}):n,o));var b=(o,e,n)=>new Promise((s,r)=>{var i=t=>{try{u(n.next(t))}catch(f){r(f)}},g=t=>{try{u(n.throw(t))}catch(f){r(f)}},u=t=>t.done?s(t.value):Promise.resolve(t.value).then(i,g);u((n=n.apply(o,e)).next())});var c=d(require("path")),m=d(require("process")),p=d(require("fs-extra"));var S=m.default.argv.slice(2),$=S.filter(o=>!o.startsWith("--")),F=$[$.length-1]||"my-blog",_=O(m.default.env.npm_config_user_agent),a=_?_.name:"npm",l=a==="bun";function O(o){if(!o)return;let n=o.split(" ")[0].split("/");return{name:n[0],version:n[1]}}function P(o){let e=c.default.join(__dirname,"template");p.default.copy(e,o,n=>b(this,null,function*(){yield p.default.copy(c.default.join(__dirname,"move/gitignore"),c.default.join(o,".gitignore"));let s=l?"bunfig.toml":"npmrc",r=l?"bunfig.toml":".npmrc";if(yield p.default.copy(c.default.join(__dirname,`move/${s}`),c.default.join(o,r)),l){let i=c.default.join(o,"package.json"),g=yield p.default.readJSON(i);g.scripts.build=`NODE_ENV=production ${g.scripts.build}`,yield p.default.writeJSON(i,g,{spaces:2})}if(n)console.error("An error occurred while copying template files:",n);else{console.log("\u{1F389} \u{1F389} created successfully!"),console.log(),console.log(`project in ${o}`),console.log();let i=`Done. Now run:
+      
+  \u2460  cd ${c.default.parse(o).name}
+  \u2461  ${a} install
+  \u2462  ${a} run ${l?"--bun ":""}dev
+  \u2463  ${a} run ${l?"--bun ":""}build
+  \u2464  ${a} run ${l?"--bun ":""}serve`;console.log(i)}}))}console.log("Creating @sugarat/theme project...");console.log();P(c.default.join(m.default.cwd(),F));

package/dist/template/docs/.vitepress/config.mts

@@ -12,6 +12,11 @@ export default defineConfig({
   title: '@sugarat/theme',
   description: '粥里有勺糖的博客主题，基于 vitepress 实现',
   lastUpdated: true,
+  // 详见：https://vitepress.dev/reference/site-config#head
+  head: [
+    // 配置网站的图标（显示在浏览器的 tab 上）
+    ['link', { rel: 'icon', href: '/favicon.ico' }]
+  ],
   themeConfig: {
     lastUpdatedText: '上次更新于',
     logo: '/logo.png',

package/dist/template/docs/about.md

@@ -29,13 +29,12 @@ sticky: 1
 * 流程图（[vitepress-plugin-mermaid](https://github.com/emersonbottero/vitepress-plugin-mermaid#readme)）
 * RSS
 * 主题色统一
+* 更多可定制的主题样式
 
 ## 规划中功能
 * Valine 评论系统
 * 文章合集（类似于聚合一个内容专题）
-* 更多可定制的主题样式
 * 文章时间线页面支持
-* 博客案例集合
 * 背景图自动更换
 * 首屏铺满slogan，参考reco
 
@@ -51,6 +50,7 @@ sticky: 1
 * [charles7c.github.io](https://github.com/Charles7c/charles7c.github.io)
 * [vitepress-blog-zaun](https://github.com/clark-cui/vitepress-blog-zaun)
 * [vuejs/blog](https://github.com/vuejs/blog/tree/main)
+* [列表无限滚动轮播效果](https://code.juejin.cn/pen/7145007064350195748)
 
 ## 主题相关资源
 * 主题地址：https://theme.sugarat.top/

package/dist/template/docs/sop/component.md

@@ -9,6 +9,13 @@ description: 默认支持流程图，tabs面板
 
 支持局部的`tabs`面板，**默认开启**
 
+:::details 我之前手动安装配置了怎么办？
+① package.json 中移除 vitepress-plugin-tabs 依赖
+
+② .vitepress/theme/index.ts 中移除注册的组件`enhanceAppWithTabs`
+
+③ （可选）`getThemeConfig` 中移除配置项`tabs`
+:::
 :::tip 一点说明
 基于 [vitepress-plugin-tabs@0.2.0](https://www.npmjs.com/package/vitepress-plugin-tabs) 内置实现
 :::
@@ -158,3 +165,115 @@ gantt
     Parallel 3   :         des5, after des3, 1d
     Parallel 4   :         des6, after des4, 1d
 ```
+
+## UserWorksPage
+* Type: `UserWorks`
+
+用于作品列表展示
+
+效果如下，详见 [个人作品展示](https://theme.sugarat.top/work.html)
+
+![](https://img.cdn.sugarat.top/mdImg/MTY4NzA4ODczMzkwNg==687088733906)
+
+新建一个`works.md`文件，放入以下内容
+  
+```md
+---
+layout: page
+title: 个人作品展示
+sidebar: false
+outline: [2,3]
+sticky: 1
+---
+<UserWorksPage />
+```
+
+内容配置方式如下
+
+::: code-group
+
+```ts [default]
+const blogTheme = getThemeConfig({
+  works: {
+    title: '个人项目/线上作品',
+    description: '记录开发的点点滴滴',
+    topTitle: '举些🌰',
+    list: [
+      {
+        title: '博客主题 @sugarat/theme',
+        description: '基于 vitepress 实现的博客主题',
+        time: {
+          start: '2023/01/29'
+        },
+        github: {
+          owner: 'ATQQ',
+          repo: 'sugar-blog',
+          branch: 'master',
+          path: 'packages/theme'
+        },
+        status: {
+          text: '自定义badge'
+        },
+        url: 'https://theme.sugarat.top',
+        cover:
+          'https://img.cdn.sugarat.top/mdImg/MTY3MzE3MDUxOTMwMw==673170519303',
+        tags: ['Vitepress', 'Vue'],
+        links: [
+          {
+            title: '一个简约风的VitePress博客主题',
+            url: 'https://juejin.cn/post/7196517835380293693'
+          }
+        ]
+      }
+    ]
+  }
+})
+```
+
+```ts [type]
+interface UserWorks {
+  title: string
+  description?: string
+  topTitle?: string
+  list: UserWork[]
+}
+interface UserWork {
+  title: string
+  description: string
+  time:
+  | string
+  | {
+    start: string
+    end?: string
+    lastupdate?: string
+  }
+  status?: {
+    text: string
+    type?: 'tip' | 'warning' | 'danger'
+  }
+  url?: string
+  github?:
+  | string
+  | {
+    owner: string
+    repo: string
+    branch?: string
+    path?: string
+  }
+  cover?:
+  | string
+  | string[]
+  | {
+    urls: string[]
+    layout?: 'swiper' | 'list'
+  }
+  links?: {
+    title: string
+    url: string
+  }[]
+  tags?: string[]
+  top?: number
+}
+```
+
+:::

package/dist/template/docs/sop/more.md

@@ -3,7 +3,7 @@ top: 3
 ---
 # 更多能力
 
-主题还提供了许多开箱即用的能力，项见文档 https://theme.sugarat.top
+主题还提供了许多开箱即用的能力，详见文档 https://theme.sugarat.top
 
 * [主题配置：首页&文章](https://theme.sugarat.top/config/frontmatter.html) - 主题提供的一些 `frontmatter`
 * [主题配置：全局](https://theme.sugarat.top/config/global.html) - 主题提供的额外能力

package/dist/template/docs/sop/quickStart.md

@@ -7,7 +7,7 @@ descriptionHTML: '
     <span class="line"><span style="color:#FFCB6B;">npm</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">create</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">@sugarat/theme@latest</span></span>
     <br/>
     <br/>
-    <span class="line"><span style="color:#B392F0;">bunx</span><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">@sugarat/create-theme</span><span style="color:#E1E4E8;"> </span><span style="color:#79B8FF;">--bun</span></span>
+    <span class="line"><span style="color:#B392F0;">bun create</span><span style="color:#E1E4E8;"> </span><span style="color:#9ECBFF;">@sugarat/theme</span><span style="color:#E1E4E8;"> </span></span>
 </code>
 </pre>'
 tag:
@@ -50,7 +50,7 @@ yarn create @sugarat/theme
 pnpm create @sugarat/theme
 ```
 ```sh [bun]
-bunx @sugarat/create-theme --bun
+bun create @sugarat/theme
 ```
 :::
 
@@ -74,7 +74,7 @@ yarn create @sugarat/theme my-first-blog
 pnpm create @sugarat/theme my-first-blog
 ```
 ```sh [bun]
-bunx @sugarat/create-theme my-first-blog --bun
+bun create @sugarat/theme my-first-blog
 ```
 :::
 

package/dist/template/docs/sop/style.md

@@ -43,7 +43,7 @@ export default BlogTheme
   );
 }
 ```
-解除注释后，就能看到模板首页背景图发生了变化
+解除文件`index.ts` 中`import './style.scss'` 注释后，就能看到模板首页背景图发生了变化
 
 ![](https://img.cdn.sugarat.top/mdImg/MTY3Njk5MTAzODkzOQ==676991038939)
 

package/dist/template/package.json

@@ -21,6 +21,6 @@
   "devDependencies": {
     "sass": "^1.64.1",
     "typescript": "^5.1.6",
-    "vitepress": "1.0.0-rc.31"
+    "vitepress": "1.0.0-rc.32"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sugarat/create-theme",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "description": "简约风的 Vitepress 博客主题，sugarat vitepress blog theme",
   "author": "粥里有勺糖",
   "license": "MIT",