@guzhongren/sha 0.1.1 → 0.1.3

package/README.md

@@ -2,16 +2,28 @@
 
 Config-driven Astro blog theme for technical writing. The theme is consumed as an Astro integration and injects default pages, layouts, and styling.
 
-## Install
+## Quick Start
+
+Scaffold a new blog in one command:
 
 ```sh
-pnpm add @guzhongren/sha astro @astrojs/mdx tailwindcss @tailwindcss/vite
+pnpm dlx @guzhongren/sha my-blog
+cd my-blog && pnpm dev
 ```
 
-## Configure
+This creates a complete project with `astro.config.mjs`, content collections bridge, and a sample post.
+
+## Manual Setup
+
+If you prefer to set up manually or add the theme to an existing Astro project:
+
+```sh
+pnpm add @guzhongren/sha astro @astrojs/mdx @astrojs/markdown-remark tailwindcss @tailwindcss/vite
+```
+
+### astro.config.mjs
 
 ```js
-// astro.config.mjs
 import { defineConfig } from "astro/config";
 import mdx from "@astrojs/mdx";
 import tailwindcss from "@tailwindcss/vite";
@@ -22,21 +34,13 @@ export default defineConfig({
   integrations: [
     blogTheme({
       site: {
-        name: "谷中的博客",
-        description: "全栈开发者的技术写作与知识沉淀",
-        lang: "zh-CN",
+        name: "My Blog",
+        title: "My Blog",
+        description: "A blog powered by @guzhongren/sha",
+        lang: "en",
       },
       author: {
-        name: "谷中",
-        headline: "全栈开发者 / 技术顾问",
-        bio: "写工程实践、架构思考、开源与日常观察。",
-        avatar: "/avatar.svg",
-      },
-      diagrams: {
-        mermaid: true,
-        plantuml: {
-          serverUrl: "https://www.plantuml.com/plantuml/svg",
-        },
+        name: "Author",
       },
     }),
     mdx(),
@@ -49,9 +53,7 @@ export default defineConfig({
 
 Register `blogTheme(...)` before `mdx()` when using theme shortcodes such as ECharts. The theme pre-processes content before MDX parses it.
 
-## Content collections
-
-Astro requires the app to export content collections:
+### Content collections bridge
 
 ```ts
 // src/content.config.ts

package/create.mjs

@@ -0,0 +1,127 @@
+#!/usr/bin/env node
+import { mkdirSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import { execSync } from "node:child_process";
+
+const name = process.argv[2];
+if (!name) {
+  console.error("Usage: pnpm dlx @guzhongren/sha <project-dir>");
+  console.error("       node create.mjs <project-dir>");
+  process.exit(1);
+}
+
+const root = join(process.cwd(), name);
+
+// Dir tree
+mkdirSync(join(root, "src", "content", "posts"), { recursive: true });
+
+// package.json
+writeFileSync(
+  join(root, "package.json"),
+  JSON.stringify(
+    {
+      name: name,
+      version: "0.0.1",
+      type: "module",
+      private: true,
+      scripts: {
+        dev: "astro dev",
+        sync: "astro sync",
+        build: "astro build",
+        preview: "astro preview",
+      },
+      dependencies: {
+        "@astrojs/markdown-remark": "^7.0.0",
+        "@astrojs/mdx": "^7.0.5",
+        "@guzhongren/sha": "^0.1.1",
+        "@tailwindcss/vite": "^4.3.3",
+        astro: "^7.1.6",
+        tailwindcss: "^4.3.3",
+      },
+    },
+    null,
+    2,
+  ) + "\n",
+);
+
+// astro.config.mjs
+writeFileSync(
+  join(root, "astro.config.mjs"),
+  `import { defineConfig } from "astro/config";
+import mdx from "@astrojs/mdx";
+import tailwindcss from "@tailwindcss/vite";
+import blogTheme from "@guzhongren/sha";
+
+export default defineConfig({
+  site: "https://example.com",
+  integrations: [
+    blogTheme({
+      site: {
+        name: "My Blog",
+        title: "My Blog",
+        description: "A blog powered by @guzhongren/sha",
+        lang: "en",
+      },
+      author: {
+        name: "Author",
+      },
+    }),
+    mdx(),
+  ],
+  vite: {
+    plugins: [tailwindcss()],
+  },
+});
+`,
+);
+
+// src/content.config.ts
+writeFileSync(
+  join(root, "src", "content.config.ts"),
+  `export { collections } from "@guzhongren/sha/content";\n`,
+);
+
+// hello-world post
+writeFileSync(
+  join(root, "src", "content", "posts", "hello-world.md"),
+  `---
+title: "Hello World"
+description: "My first blog post"
+publishDate: ${new Date().toISOString().slice(0, 10)}
+category: "Uncategorized"
+tags: ["hello"]
+---
+
+Welcome to my blog! 🎉
+`,
+);
+
+// tsconfig.json
+writeFileSync(
+  join(root, "tsconfig.json"),
+  `{
+  "extends": "astro/tsconfigs/strict"
+}
+`,
+);
+
+// .gitignore
+writeFileSync(join(root, ".gitignore"), "node_modules/\n.astro/\ndist/\n");
+
+// pnpm-workspace.yaml (minimumReleaseAgeExclude for fresh packages)
+writeFileSync(
+  join(root, "pnpm-workspace.yaml"),
+  `allowBuilds:
+  esbuild: true
+minimumReleaseAgeExclude:
+  - "@guzhongren/sha"
+`,
+);
+
+// Install deps
+console.log(`\n✓ Scaffolded "${name}"`);
+console.log("Installing dependencies...\n");
+execSync("pnpm install", { cwd: root, stdio: "inherit" });
+
+console.log(`\n✓ Done! Start the dev server:\n`);
+console.log(`  cd ${name} && pnpm dev\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guzhongren/sha",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "type": "module",
   "description": "个人 Astro 博客主题 — 开箱即用的内容驱动博客",
   "license": "MIT",
@@ -15,22 +15,27 @@
   ],
   "files": [
     "src/",
+    "create.mjs",
     "README.md",
     "LICENSE"
   ],
+  "bin": {
+    "create-sha-blog": "./create.mjs"
+  },
   "exports": {
     ".": "./src/index.ts",
     "./content": "./src/content.ts",
     "./styles.css": "./src/styles/global.css"
   },
   "peerDependencies": {
-    "astro": "^7.1.3",
-    "@astrojs/mdx": "^7.0.0",
     "@astrojs/markdown-remark": "^7.0.0",
+    "@astrojs/mdx": "^7.0.0",
     "@tailwindcss/vite": "^4.0.0",
+    "astro": "^7.1.3",
     "tailwindcss": "^4.0.0"
   },
   "dependencies": {
+    "@astrojs/rss": "^4.0.19",
     "echarts": "^6.1.0",
     "gemoji": "^8.1.0",
     "mermaid": "^11.16.0",

package/src/config.ts

@@ -49,6 +49,7 @@ export function normalizeOptions(options: BlogThemeOptions): NormalizedBlogTheme
             categories: false,
             about: false,
             search: false,
+            rss: false,
           }
         : {
             home: options.routes?.home ?? true,
@@ -57,6 +58,7 @@ export function normalizeOptions(options: BlogThemeOptions): NormalizedBlogTheme
             categories: options.routes?.categories ?? true,
             about: options.routes?.about ?? true,
             search: options.routes?.search ?? true,
+            rss: options.routes?.rss ?? true,
           },
   };
 }

package/src/index.ts

@@ -100,6 +100,7 @@ export default function blogTheme(options: BlogThemeOptions): AstroIntegration {
         }
         if (config.routes.about) injectRoute({ pattern: "/about", entrypoint: route("./pages/about.astro") });
         if (config.routes.search) injectRoute({ pattern: "/search", entrypoint: route("./pages/search.astro") });
+        if (config.routes.rss) injectRoute({ pattern: "/rss.xml", entrypoint: route("./pages/rss.xml.ts") });
       },
       "astro:build:done": async ({ dir }) => {
         if (!config.routes.search) return;

package/src/pages/rss.xml.ts

@@ -0,0 +1,22 @@
+import rss from "@astrojs/rss";
+import { getCollection } from "astro:content";
+import config from "virtual:blog-theme/config";
+import { isPublished, sortPosts, postHref } from "../utils";
+
+export async function GET(context: { site: URL }) {
+  const posts = sortPosts((await getCollection("posts")).filter(isPublished));
+
+  return rss({
+    xmlns: { atom: "http://www.w3.org/2005/Atom" },
+    title: config.site.title,
+    description: config.site.description,
+    site: context.site,
+    items: posts.map((post) => ({
+      title: post.data.title,
+      description: post.data.description,
+      pubDate: post.data.publishDate ?? new Date(),
+      link: postHref(post),
+    })),
+    customData: `<language>${config.site.lang}</language>`,
+  });
+}

package/src/types.ts

@@ -46,6 +46,7 @@ export type BlogThemeOptions = {
         categories?: boolean;
         about?: boolean;
         search?: boolean;
+        rss?: boolean;
       };
 };
 
@@ -90,5 +91,6 @@ export type NormalizedBlogThemeOptions = {
     categories: boolean;
     about: boolean;
     search: boolean;
+    rss: boolean;
   };
 };