create-jant 0.3.28 → 0.3.29

package/dist/index.js

@@ -9,7 +9,7 @@ import path from "path";
 import { fileURLToPath } from "url";
 var __filename = fileURLToPath(import.meta.url);
 var __dirname = path.dirname(__filename);
-var CORE_VERSION = "0.3.28";
+var CORE_VERSION = "0.3.29";
 var TEMPLATE_DIR = fs.existsSync(path.resolve(__dirname, "../template")) ? path.resolve(__dirname, "../template") : path.resolve(__dirname, "../../../sites/demo");
 function isValidProjectName(name) {
   return /^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(name);
@@ -96,6 +96,17 @@ async function copyTemplate(config) {
       return true;
     }
   });
+  const renames = [
+    ["_gitignore", ".gitignore"],
+    ["_github", ".github"]
+  ];
+  for (const [from, to] of renames) {
+    const fromPath = path.join(targetDir, from);
+    const toPath = path.join(targetDir, to);
+    if (await fs.pathExists(fromPath)) {
+      await fs.rename(fromPath, toPath);
+    }
+  }
   const pkgPath = path.join(targetDir, "package.json");
   if (await fs.pathExists(pkgPath)) {
     const pkg = await fs.readJson(pkgPath);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-jant",
-  "version": "0.3.28",
+  "version": "0.3.29",
   "description": "Create a new Jant project",
   "type": "module",
   "bin": {
@@ -53,7 +53,7 @@
     "build": "tsup src/index.ts --format esm --clean --outDir dist",
     "dev": "tsup src/index.ts --format esm --watch",
     "typecheck": "tsc --noEmit",
-    "copy-template": "rm -rf template && rsync -a --exclude node_modules --exclude .wrangler --exclude .dev.vars ../../sites/demo/ template/",
+    "copy-template": "rm -rf template && rsync -a --exclude node_modules --exclude .wrangler --exclude .dev.vars --exclude scripts ../../sites/demo/ template/ && mv template/.gitignore template/_gitignore && mv template/.github template/_github",
     "inject-version": "node -e \"const fs=require('fs');const v=require('../core/package.json').version;const f='dist/index.js';fs.writeFileSync(f,fs.readFileSync(f,'utf8').replace('__JANT_CORE_VERSION__',v))\"",
     "test-template": "node scripts/test-template.js"
   }

package/template/.dev.vars.example

@@ -0,0 +1,12 @@
+# Secrets — do not commit this file
+#
+# Cloudflare Workers: copy to .dev.vars
+# VPS / Docker:      copy to .env
+
+# AUTH_SECRET must be at least 32 characters
+# Generate one with: openssl rand -base64 32
+AUTH_SECRET=your-secret-key-at-least-32-chars-long
+
+# Required when STORAGE_DRIVER=s3:
+# S3_ACCESS_KEY_ID=your-access-key
+# S3_SECRET_ACCESS_KEY=your-secret-key

package/template/README.md

@@ -0,0 +1,118 @@
+# Jant
+
+A personal microblogging system — self-hosted, single-author, and stripped of all social mechanics. Runs on Cloudflare Workers.
+
+## Quick Start
+
+### One-Click Deploy
+
+[![Deploy to Cloudflare](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/jant-me/jant-starter)
+
+### CLI
+
+```bash
+npm create jant my-site
+cd my-site
+npm run dev
+```
+
+### Manual Deploy
+
+1. **Create a D1 database:**
+
+   ```bash
+   npx wrangler d1 create my-site-db
+   ```
+
+2. **Update `wrangler.toml`** with the `database_id` from step 1 and set your `SITE_URL`.
+
+3. **Set production secrets:**
+
+   ```bash
+   npx wrangler secret put AUTH_SECRET
+   ```
+
+4. **Deploy:**
+
+   ```bash
+   npm run deploy
+   ```
+
+## Commands
+
+| Command          | Description                                 |
+| ---------------- | ------------------------------------------- |
+| `npm run dev`    | Start local dev server (applies migrations) |
+| `npm run deploy` | Deploy to Cloudflare (applies migrations)   |
+
+## Environment Variables
+
+Configuration is set in `wrangler.toml` and `.dev.vars`. See [Configuration](https://github.com/jant-me/jant/blob/main/docs/configuration.md) for the full reference.
+
+**Required:**
+
+| Variable      | Where           | Description                        |
+| ------------- | --------------- | ---------------------------------- |
+| `SITE_URL`    | `wrangler.toml` | Your site's public URL             |
+| `AUTH_SECRET` | `.dev.vars`     | Session encryption key (32+ chars) |
+
+**Optional (in `wrangler.toml`):**
+
+| Variable              | Description                               |
+| --------------------- | ----------------------------------------- |
+| `SITE_NAME`           | Display name (also settable in dashboard) |
+| `SITE_DESCRIPTION`    | Meta description / RSS subtitle           |
+| `SITE_LANGUAGE`       | Language code (`en`, `zh`, etc.)          |
+| `R2_PUBLIC_URL`       | Public URL for R2 media bucket            |
+| `IMAGE_TRANSFORM_URL` | Cloudflare Image Transformations URL      |
+
+## GitHub Actions CI/CD
+
+The included workflow (`.github/workflows/deploy.yml`) deploys on every push to `main`.
+
+**Setup:**
+
+1. Add these **repository secrets** in Settings > Secrets and variables > Actions:
+   - `CF_API_TOKEN` — Cloudflare API token with Workers, D1, and R2 permissions
+   - `CF_ACCOUNT_ID` — your Cloudflare account ID
+2. Set your production `AUTH_SECRET`:
+   ```bash
+   npx wrangler secret put AUTH_SECRET
+   ```
+3. Push to `main` — the workflow handles migrations and deployment.
+
+## Customization
+
+### CSS Tokens
+
+Customize colors through the dashboard (Settings > Appearance) or by overriding CSS variables. See [Theming](https://github.com/jant-me/jant/blob/main/docs/theming.md).
+
+### Data Attributes
+
+Target specific elements for styling with stable data attributes:
+
+| Attribute        | Purpose                       |
+| ---------------- | ----------------------------- |
+| `data-page`      | Page type identifier          |
+| `data-post`      | Post marker                   |
+| `data-format`    | Post format (note/link/quote) |
+| `data-post-body` | Post body content             |
+
+### Code-Level
+
+For deeper changes, fork the project and modify `@jant/core` directly.
+
+## Updating
+
+```bash
+npm update @jant/core
+npm run deploy
+```
+
+Check the [changelog](https://github.com/jant-me/jant/releases) for breaking changes before updating.
+
+## Documentation
+
+- [Configuration](https://github.com/jant-me/jant/blob/main/docs/configuration.md)
+- [Theming](https://github.com/jant-me/jant/blob/main/docs/theming.md)
+- [GitHub](https://github.com/jant-me/jant)

package/template/_github/workflows/deploy.yml

@@ -0,0 +1,47 @@
+# Deploy your Jant site to Cloudflare Workers.
+#
+# Prerequisites:
+# 1. Create a D1 database: npx wrangler d1 create <name>
+# 2. Update wrangler.toml with the database_id
+# 3. Add repository secrets: CF_API_TOKEN, CF_ACCOUNT_ID
+# 4. Set production secret: npx wrangler secret put AUTH_SECRET
+#
+# Full setup guide: https://github.com/jant-me/jant
+
+name: Deploy
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run migrations
+        run: npx wrangler d1 migrations apply DB --remote
+        env:
+          CLOUDFLARE_API_TOKEN: ${{ secrets.CF_API_TOKEN }}
+          CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }}
+
+      - name: Deploy to Cloudflare Workers
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CF_API_TOKEN }}
+          accountId: ${{ secrets.CF_ACCOUNT_ID }}
+          command: deploy

package/template/_gitignore

@@ -0,0 +1,12 @@
+node_modules/
+.wrangler/
+.dev.vars
+.env
+.env.*
+!.env.example
+.idea/
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+.DS_Store
+*.log

package/template/package.json

@@ -4,7 +4,8 @@
   "type": "module",
   "scripts": {
     "dev": "wrangler d1 migrations apply DB --local && wrangler dev",
-    "deploy": "wrangler d1 migrations apply DB --remote && wrangler deploy"
+    "deploy": "wrangler d1 migrations apply DB --remote && wrangler deploy",
+    "reset-password": "jant-reset-password"
   },
   "dependencies": {
     "@jant/core": "workspace:*"