create-open17-blog 1.0.0

package/README.md

@@ -0,0 +1,65 @@
+# create-open17-blog
+
+A CLI tool for quickly setting up VitePress blog with `vitepress-theme-open17`
+
+## Usage
+
+```bash
+npm create open17-blog my-blog
+# or
+yarn create open17-blog my-blog
+# or  
+pnpm create open17-blog my-blog
+# or
+bun create open17-blog my-blog
+```
+
+You can also run it without arguments to create a blog in current directory:
+
+```bash
+npm create open17-blog
+```
+
+## Features
+
+- 🚀 Quick scaffolding with minimal setup
+- 📁 Generates proper project structure
+- 🎨 Preconfigured with open17 theme defaults  
+- 📝 Sample blog post included
+- ⚙️ Type-safe configuration
+- 🔧 Works with npm/yarn/pnpm/bun
+
+## What it creates
+
+```
+my-blog/
+├── docs/
+│   ├── .vitepress/
+│   │   ├── config.ts          # VitePress config with theme
+│   │   └── theme/
+│   │       └── index.ts       # Theme entry
+│   ├── posts/
+│   │   └── 2024-xx-xx-hello-open17.md  # Sample post
+│   ├── index.md               # Homepage with <blog /> component
+│   └── public/                # Static assets
+├── package.json
+└── .gitignore
+```
+
+## After scaffolding
+
+```bash
+cd my-blog
+npm install
+npm run dev
+```
+
+Your blog will be available at http://localhost:8090
+
+## Options
+
+- `-f, --force` - Overwrite target directory if it exists
+
+## License
+
+Apache-2.0

package/dist/index.js

@@ -0,0 +1,93 @@
+#!/usr/bin/env node
+import{Command as w}from"commander";import v from"inquirer";import t from"path";import r from"fs-extra";import n from"chalk";import b from"ora";import y from"validate-npm-package-name";var f=new w;f.name("create-open17-blog").description("Create a VitePress blog preconfigured with vitepress-theme-open17").version("1.0.0").argument("[project-name]","Folder to create the project in").option("-f, --force","Overwrite target directory if it exists",!1).action(async(e,c)=>{var i,s;try{let o=process.cwd(),l=e?t.resolve(o,e):o,a=e;a||(a=(await v.prompt([{name:"name",type:"input",message:"Project name:",default:"my-open17-blog"}])).name);let m=y(a);m.validForNewPackages||(console.error(n.red("Invalid project name: "+a)),(i=m.errors)==null||i.forEach(g=>console.error(n.red("  "+g))),(s=m.warnings)==null||s.forEach(g=>console.error(n.yellow("  "+g))),process.exit(1));let p=e?l:t.resolve(o,a);if(r.existsSync(p)){if(!((await r.readdir(p)).length===0)&&!c.force){let{overwrite:u}=await v.prompt([{name:"overwrite",type:"confirm",message:`Target directory ${n.cyan(p)} is not empty. Overwrite?`,default:!1}]);u||process.exit(1),await r.emptyDir(p)}}else await r.ensureDir(p);let h=b("Scaffolding project...").start();await j(p,a),h.succeed("Project scaffolded");let d=k();console.log(),console.log(n.green("Done. Now run:")),e&&console.log("  cd "+n.cyan(e)),console.log(`  ${d} install`),console.log(`  ${d} run dev`),console.log()}catch(o){console.error(n.red(o.message)),process.exit(1)}});f.parse();async function j(e,c){let i=t.join(e,"docs"),s=t.join(i,".vitepress"),o=t.join(s,"theme");await r.ensureDir(o);let l={name:c,private:!0,type:"module",scripts:{dev:"vitepress dev docs --port 8090",build:"vitepress build docs",preview:"vitepress preview docs"},dependencies:{vite:"^5.2.14",vitepress:"^1.3.4",vue:"^3.4.21","@giscus/vue":"^3.0.0","vitepress-sidebar":"^1.22.0","vitepress-theme-open17":"^1.3.5"},devDependencies:{}};await r.writeJSON(t.join(e,"package.json"),l,{spaces:2}),await r.writeFile(t.join(e,".gitignore"),`node_modules
+dist
+docs/.vitepress/cache/*
+`),await r.writeFile(t.join(i,"index.md"),x()),await r.ensureDir(t.join(i,"posts")),await r.writeFile(t.join(i,"posts",`${D(new Date)}-hello-open17.md`),T()),await r.ensureDir(t.join(i,"page")),await r.writeFile(t.join(i,"page","tags.md"),I()),await r.writeFile(t.join(i,"page","archive.md"),C()),await r.writeFile(t.join(s,"config.ts"),P()),await r.writeFile(t.join(o,"index.ts"),F()),await r.ensureDir(t.join(i,"public"))}function k(){let e=process.env.npm_config_user_agent||"";return e.startsWith("yarn")?"yarn":e.startsWith("pnpm")?"pnpm":e.startsWith("bun")?"bun":"npm"}function D(e){let c=e.getFullYear(),i=String(e.getMonth()+1).padStart(2,"0"),s=String(e.getDate()).padStart(2,"0");return`${c}-${i}-${s}`}function x(){return`---
+layout: blog
+bgImage:
+  light: "https://vitepress.open17.vip/bg.jpg"
+  dark: "https://vitepress.open17.vip/bg2_dark.jpg"
+---
+`}function T(){return`---
+title: Hello,World!
+date: 2025-08-11
+tags:
+  - Hello World
+
+---
+
+
+\u8FD9\u662F\u4F60\u7684\u7B2C\u4E00\u7BC7\u6587\u7AE0\uFF0C\u6765\u81EA vitepress-theme-open17 CLI \u521D\u59CB\u5316\u3002
+
+---
+
+:::tip \u2728 \u4E3A\u4EC0\u4E48\u9009\u62E9 Open17\uFF1F
+
+**\u65E0\u7F1D\u6CBF\u7528 VitePress \u9ED8\u8BA4\u914D\u7F6E\uFF0C\u8F7B\u677E\u6784\u5EFA\u4F60\u7684\u4E2A\u6027\u5316\u535A\u5BA2**
+
+Open17 \u662F\u4E00\u6B3E\u4E13\u4E3A VitePress \u8BBE\u8BA1\u7684\u73B0\u4EE3\u5316\u535A\u5BA2\u4E3B\u9898\uFF0C\u5728\u4FDD\u6301\u539F\u6709\u5F3A\u5927\u529F\u80FD\u7684\u57FA\u7840\u4E0A\uFF0C\u4E3A\u4F60\u5E26\u6765\u5168\u65B0\u7684\u535A\u5BA2\u4F53\u9A8C\u3002
+:::
+
+## \u4F7F\u7528\u8BF4\u660E
+
+- \u4F7F\u7528 /docs/posts \u4E0B\u7684 md \u6587\u4EF6\u4F5C\u4E3A\u535A\u5BA2\u6587\u7AE0
+
+
+
+## \u{1F4DA} \u5B8C\u6574\u6307\u5357
+
+- \u{1F4D6} [\u5FEB\u901F\u5F00\u59CB](https://vitepress.open17.vip/blog-docs/0-intro/0-start.html) - 5\u5206\u949F\u4E0A\u624B\u6307\u5357
+- \u2699\uFE0F [\u4E3B\u9898\u914D\u7F6E](https://vitepress.open17.vip/blog-docs/1-config/) - \u8BE6\u7EC6\u914D\u7F6E\u8BF4\u660E
+- \u{1F3A8} [\u6837\u5F0F\u5B9A\u5236](https://vitepress.open17.vip/blog-docs/1-config/2-style.html) - \u6253\u9020\u4E13\u5C5E\u98CE\u683C
+- \u{1F527} [\u8FDB\u9636\u4F7F\u7528](https://vitepress.open17.vip/blog-docs/2-more/) - \u9AD8\u7EA7\u529F\u80FD\u63A2\u7D22
+`}function P(){return`import { defineConfigWithTheme } from 'vitepress'
+import type { ThemeConfig } from 'vitepress-theme-open17/config'
+
+export default defineConfigWithTheme<ThemeConfig>({
+  title: 'Blog Demo',
+  description: 'A VitePress Site',
+  themeConfig: {
+    search: { provider: 'local' },
+    blog: {
+      direct: 'rgt',
+      user: {
+        name: 'Open17',
+        avatar: 'https://vitepress.open17.vip/ava.jpg',
+        describe: 'Made with \u2764\uFE0F by open17',
+      },
+      tagPageLink: '/page/tags',
+      bgImage: { dark: "https://vitepress.open17.vip/bg_dark.jpg" },
+    },
+    nav: [
+      { text: "Home", link: "/" },
+      {
+        text: "Others",
+        items: [
+          { text: "Tags", link: "/page/tags" },
+          { text: "Archive", link: " /page/archive" },
+        ],
+      },
+    ],
+    home: {
+      maxTagsDisplayed: 20,
+      postsPerPage: 3
+    },
+  }
+})
+`}function F(){return`import Theme from 'vitepress-theme-open17'
+export default Theme
+`}function I(){return`---
+layout: tags
+lastUpdated: false
+bgImage:
+  light: "https://vitepress.open17.vip/bg.jpg"
+  dark: "https://vitepress.open17.vip/bg2_dark.jpg"
+---
+`}function C(){return`---
+layout: archive
+lastUpdated: false
+bgImage:
+  light: "https://vitepress.open17.vip/bg.jpg"
+  dark: "https://vitepress.open17.vip/bg2_dark.jpg"
+---
+`}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "create-open17-blog",
+  "version": "1.0.0",
+  "description": "CLI tool for quickly setting up vitepress-theme-open17 blog",
+  "type": "module",
+  "main": "./dist/index.js",
+  "bin": {
+    "create-open17-blog": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "vitepress",
+    "blog",
+    "cli",
+    "scaffolding",
+    "open17"
+  ],
+  "author": "open17 <opensci@163.com>",
+  "license": "Apache-2.0",
+  "repository": "https://github.com/open17/vitepress-theme-open17.git",
+  "homepage": "https://vitepress.open17.vip",
+  "dependencies": {
+    "commander": "^11.1.0",
+    "inquirer": "^9.2.11",
+    "chalk": "^5.3.0",
+    "ora": "^7.0.1",
+    "fs-extra": "^11.1.1",
+    "validate-npm-package-name": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.0",
+    "@types/inquirer": "^9.0.7",
+    "@types/fs-extra": "^11.0.4",
+    "typescript": "^5.6.3",
+    "tsup": "^8.0.1"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --target node16 --minify",
+    "dev": "tsup src/index.ts --format esm --target node16 --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}