@vited/create 0.0.4 → 0.0.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Added
+
+- Generate `docs/favicon.svg` for new projects without overwriting an existing favicon.
+
 ## 0.0.4 - 2026-10-28
 
 ### Fixed

package/README.md

@@ -33,10 +33,20 @@ pnpm dlx @vited/create my-docs \
   --no-install
 ```
 
-The generated project includes `vited.config.ts`, a `docs` directory, and
-`docs:dev` / `docs:build` scripts. `@vited/core` provides the HTML shell, so no
-`index.html` is added to the project. Existing package scripts and documentation
-files are preserved. An existing `vited.config.ts` is not overwritten.
+The generated project includes `vited.config.ts`, a `docs` directory with a
+default `favicon.svg`, and `docs:dev` / `docs:build` scripts. `@vited/core`
+provides the HTML shell, so no `index.html` is added to the project. Existing
+package scripts and documentation files are preserved. The generated
+`.gitignore` ignores the default `docs_dist` build output. The starter
+documentation is English in `docs/README.md` with a Chinese translation in
+`docs/README.zh.md`. An existing `vited.config.ts` is not overwritten.
 If it already exists, `vited-new.config.ts` is created or overwritten for comparison.
 When installing with pnpm, the required `@swc/core` and `esbuild` build scripts
 are approved automatically to comply with pnpm's build-script policy.
+
+When a GitHub repository is detected from the `origin` remote or the
+`repository` field in `package.json`, create adds a GitHub Pages workflow and
+sets the Vite and Vited base URLs to the repository path. The workflow deploys
+the `docs_dist` build output. User and organization sites named
+`<owner>.github.io` use the root URL. In the repository settings,
+select **Settings → Pages → Source → GitHub Actions** to enable the workflow.

package/dist/index.d.mts

@@ -1,6 +1,6 @@
+type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun';
 export declare const THEMES: readonly ["@vited/theme-mantine"];
 export type Theme = (typeof THEMES)[number];
-export type PackageManager = 'npm' | 'pnpm' | 'yarn' | 'bun';
 export type ProjectMode = 'create' | 'init';
 export interface CreateOptions {
   directory: string;
@@ -15,4 +15,5 @@ export interface CreateResult {
 }
 export declare function resolvePackageManager(projectPath: string, environment?: NodeJS.ProcessEnv): Promise<PackageManager>;
 export declare function create({ directory, theme, packageManager, install }: CreateOptions): Promise<CreateResult>;
-export declare function installPackages(projectPath: string, packageManager: PackageManager): Promise<void>;
+export declare function installPackages(projectPath: string, packageManager: PackageManager): Promise<void>;
+export type { PackageManager };

package/dist/index.mjs

@@ -1 +1 @@
-export { t as THEMES, n as create, r as installPackages, i as resolvePackageManager } from "./src-BWiFwqr3.mjs";
+export { t as THEMES, n as create, r as installPackages, i as resolvePackageManager } from "./src-BAeU7i-K.mjs";

package/dist/{src-BWiFwqr3.mjs → src-BAeU7i-K.mjs}

@@ -1,8 +1,164 @@
-import { spawn } from "node:child_process";
+import { execFile, spawn } from "node:child_process";
 import { mkdir, readFile, stat, writeFile } from "node:fs/promises";
 import path from "node:path";
 import process from "node:process";
+import { URL } from "node:url";
+import { promisify } from "node:util";
 import i18next from "i18next";
+// src/github.ts
+const execFileAsync = promisify(execFile);
+async function getGitHubPagesSetup(projectPath, repository, packageManager) {
+	const githubRepository = await findGitHubRepository(projectPath, repository);
+	if (!githubRepository) return;
+	return {
+		base: getGitHubBaseURL(githubRepository),
+		workflow: makeGitHubPagesWorkflow(packageManager)
+	};
+}
+async function writeGitHubPagesWorkflow(projectPath, content) {
+	const workflowPath = path.join(projectPath, ".github", "workflows", "pages.yaml");
+	await mkdir(path.dirname(workflowPath), { recursive: true });
+	try {
+		await writeFile(workflowPath, content, { flag: "wx" });
+	} catch (error) {
+		if (!isNodeError$1(error, "EEXIST")) throw error;
+	}
+}
+async function findGitHubRepository(projectPath, repository) {
+	let originURL;
+	try {
+		originURL = (await execFileAsync("git", [
+			"remote",
+			"get-url",
+			"origin"
+		], {
+			cwd: projectPath,
+			encoding: "utf8"
+		})).stdout.trim();
+	} catch (error) {
+		if (!isExpectedGitLookupFailure(error)) throw error;
+	}
+	return parseGitHubRepository(originURL) ?? parseGitHubRepository(getRepositoryURL(repository));
+}
+function isExpectedGitLookupFailure(error) {
+	if (isNodeError$1(error, "ENOENT")) return true;
+	if (!isRecord$1(error)) return false;
+	const code = error["code"];
+	return typeof code === "number" && [2, 128].includes(code);
+}
+function getRepositoryURL(repository) {
+	if (typeof repository === "string") return repository;
+	if (isRecord$1(repository) && typeof repository["url"] === "string") return repository["url"];
+}
+function parseGitHubRepository(repositoryURL) {
+	if (!repositoryURL) return;
+	const value = repositoryURL.trim().replace(/^git\+/, "");
+	const scpMatch = /^(?:[^@/]+@)?github\.com:([^/]+)\/([^/?#]+)$/i.exec(value);
+	const shorthandMatch = /^(?:github:)?([^/]+)\/([^/?#]+)$/i.exec(value);
+	const shorthand = scpMatch ?? shorthandMatch;
+	if (shorthand?.[1] && shorthand[2]) return makeGitHubRepository(shorthand[1], shorthand[2]);
+	let url;
+	try {
+		url = new URL(value);
+	} catch (error) {
+		if (error instanceof TypeError) return;
+		throw error;
+	}
+	if (url.hostname.toLowerCase() !== "github.com" || ![
+		"git:",
+		"http:",
+		"https:",
+		"ssh:"
+	].includes(url.protocol)) return;
+	const pathSegments = url.pathname.split("/").filter(Boolean);
+	if (pathSegments.length !== 2) return;
+	const [owner, name] = pathSegments;
+	if (!owner || !name) return;
+	return makeGitHubRepository(owner, name);
+}
+function makeGitHubRepository(owner, name) {
+	return {
+		owner,
+		name: name.replace(/\.git$/i, "")
+	};
+}
+function getGitHubBaseURL(repository) {
+	return repository.name.toLowerCase() === `${repository.owner.toLowerCase()}.github.io` ? "/" : `/${repository.name}/`;
+}
+function makeGitHubPagesWorkflow(packageManager) {
+	const setupPackageManagerSteps = {
+		npm: [],
+		pnpm: ["      - uses: pnpm/action-setup@v4"],
+		yarn: ["      - run: corepack enable"],
+		bun: ["      - uses: oven-sh/setup-bun@v2"]
+	}[packageManager];
+	const installSteps = {
+		npm: ["      - run: npm install"],
+		pnpm: ["      - run: pnpm approve-builds @swc/core esbuild", "      - run: pnpm install"],
+		yarn: ["      - run: yarn install"],
+		bun: ["      - run: bun install"]
+	}[packageManager];
+	const buildCommand = {
+		npm: "npm run docs:build",
+		pnpm: "pnpm run docs:build",
+		yarn: "yarn docs:build",
+		bun: "bun run docs:build"
+	}[packageManager];
+	return [
+		"name: Deploy docs to GitHub Pages",
+		"",
+		"on:",
+		"  push:",
+		"    branches:",
+		"      - main",
+		"      - master",
+		"  workflow_dispatch:",
+		"",
+		"permissions:",
+		"  contents: read",
+		"  pages: write",
+		"",
+		"concurrency:",
+		"  group: github-pages",
+		"  cancel-in-progress: false",
+		"",
+		"jobs:",
+		"  build:",
+		"    runs-on: ubuntu-latest",
+		"    steps:",
+		"      - uses: actions/checkout@v6",
+		"      - uses: actions/setup-node@v6",
+		"        with:",
+		"          node-version: 22",
+		...setupPackageManagerSteps,
+		"      - uses: actions/configure-pages@v5",
+		...installSteps,
+		`      - run: ${buildCommand}`,
+		"      - uses: actions/upload-pages-artifact@v4",
+		"        with:",
+		"          path: ./docs_dist",
+		"",
+		"  deploy:",
+		"    environment:",
+		"      name: github-pages",
+		"      url: ${{ steps.deployment.outputs.page_url }}",
+		"    runs-on: ubuntu-latest",
+		"    needs: build",
+		"    permissions:",
+		"      pages: write",
+		"      id-token: write",
+		"    steps:",
+		"      - id: deployment",
+		"        uses: actions/deploy-pages@v4",
+		""
+	].join("\n");
+}
+function isNodeError$1(error, code) {
+	return error instanceof Error && "code" in error && error.code === code;
+}
+function isRecord$1(value) {
+	return typeof value === "object" && value === Object(value) && !Array.isArray(value);
+}
 // src/i18n.ts
 const LANGUAGES = ["en", "zh"];
 const resources = {
@@ -152,12 +308,18 @@ async function create({ directory, theme, packageManager, install }) {
 	const packageJsonPath = path.join(projectPath, "package.json");
 	const packageJson = await readProjectPackageJson(packageJsonPath, projectPath);
 	addVitedConfiguration(packageJson, projectPath, theme);
+	const githubPages = await getGitHubPagesSetup(projectPath, packageJson["repository"], packageManager);
+	const base = githubPages?.base;
 	await mkdir(projectPath, { recursive: true });
+	await ensureGitignoreEntry(projectPath, "docs_dist");
 	const docsPath = path.join(projectPath, "docs");
 	await mkdir(docsPath, { recursive: true });
 	await writeFile(packageJsonPath, `${JSON.stringify(packageJson, void 0, 2)}\n`);
-	await writeFile(configPath, makeVitedConfig(packageJson, theme), { flag: overwriteConfig ? "w" : "wx" });
-	await writeIfMissing(path.join(docsPath, "README.md"), makeReadme(packageJson));
+	await writeFile(configPath, makeVitedConfig(packageJson, theme, base), { flag: overwriteConfig ? "w" : "wx" });
+	await writeIfMissing(path.join(docsPath, "favicon.svg"), await readFile(new URL("../favicon.svg", import.meta.url), "utf8"));
+	await writeIfMissing(path.join(docsPath, "README.md"), makeReadme(packageJson, "en"));
+	await writeIfMissing(path.join(docsPath, "README.zh.md"), makeReadme(packageJson, "zh"));
+	if (githubPages) await writeGitHubPagesWorkflow(projectPath, githubPages.workflow);
 	if (install) await installPackages(projectPath, packageManager);
 	return {
 		projectPath,
@@ -294,12 +456,13 @@ async function fileExists(filePath) {
 function toPackageName(value) {
 	return value.toLowerCase().replaceAll(/[^a-z0-9._-]+/g, "-").replaceAll(/^-+|-+$/g, "") || "vited-docs";
 }
-function makeVitedConfig(packageJson, theme) {
+function makeVitedConfig(packageJson, theme, base) {
 	const title = typeof packageJson["name"] === "string" && packageJson["name"].length > 0 ? packageJson["name"] : "Vited documentation";
 	return [
 		"import { defineConfig } from '@vited/core';",
 		"",
 		"export default defineConfig({",
+		`  base: ${JSON.stringify(base ?? "/")},`,
 		"  docs: {",
 		`    title: ${JSON.stringify(title)},`,
 		`    theme: ${JSON.stringify(theme)},`,
@@ -308,8 +471,8 @@ function makeVitedConfig(packageJson, theme) {
 		""
 	].join("\n");
 }
-function makeReadme(packageJson) {
-	return `# ${typeof packageJson["name"] === "string" && packageJson["name"].length > 0 ? packageJson["name"] : "Vited documentation"}\n\n${t("template.docsWelcome")}\n`;
+function makeReadme(packageJson, language) {
+	return `# ${typeof packageJson["name"] === "string" && packageJson["name"].length > 0 ? packageJson["name"] : "Vited documentation"}\n\n${t("template.docsWelcome", { lng: language })}\n`;
 }
 async function writeIfMissing(filePath, content) {
 	try {
@@ -318,4 +481,20 @@ async function writeIfMissing(filePath, content) {
 		if (!isNodeError(error, "EEXIST")) throw error;
 	}
 }
+async function ensureGitignoreEntry(projectPath, entry) {
+	const gitignorePath = path.join(projectPath, ".gitignore");
+	let contents;
+	try {
+		contents = await readFile(gitignorePath, "utf8");
+	} catch (error) {
+		if (!isNodeError(error, "ENOENT")) throw error;
+		contents = "";
+	}
+	if (contents.split(/\r?\n/).some((line) => {
+		return line.trim().replaceAll(/^\/+|\/+$/g, "") === entry;
+	})) return;
+	const lineEnding = contents.includes("\r\n") ? "\r\n" : "\n";
+	const separator = contents.length > 0 && !contents.endsWith("\n") ? lineEnding : "";
+	await writeFile(gitignorePath, `${contents}${separator}${entry}${lineEnding}`);
+}
 export { LANGUAGES as a, t as c, resolvePackageManager as i, create as n, isLanguage as o, installPackages as r, setLanguage as s, THEMES as t };

package/dist/vited-create.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { a as LANGUAGES, c as t, i as resolvePackageManager, n as create, o as isLanguage, s as setLanguage, t as THEMES } from "./src-BWiFwqr3.mjs";
+import { a as LANGUAGES, c as t, i as resolvePackageManager, n as create, o as isLanguage, s as setLanguage, t as THEMES } from "./src-BAeU7i-K.mjs";
 import process from "node:process";
 import console from "node:console";
 import { Command, Option } from "commander";

package/favicon.svg

@@ -0,0 +1,20 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128">
+  <defs>
+    <linearGradient id="bolt" x1="30" y1="14" x2="95" y2="107" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#ffe76b" />
+      <stop offset=".38" stop-color="#ff9a43" />
+      <stop offset=".72" stop-color="#d94fe8" />
+      <stop offset="1" stop-color="#6657f5" />
+    </linearGradient>
+    <clipPath id="shape">
+      <path d="M75 8 29 62h27l-9 58 53-70H73L94 8H75Z" />
+    </clipPath>
+  </defs>
+  <path d="M75 8 29 62h27l-9 58 53-70H73L94 8H75Z" fill="url(#bolt)" />
+  <g clip-path="url(#shape)">
+    <path d="M22 18h61L56 62H22Z" fill="#fff1a1" opacity=".58" />
+    <path d="m56 62 17-14h28l-53 72 9-58Z" fill="#654ce1" opacity=".5" />
+    <path d="m73 8 21 0-21 42H55Z" fill="#fff" opacity=".18" />
+    <path d="m56 62 17-14-26 72 9-58Z" fill="#ff6b5b" opacity=".45" />
+  </g>
+</svg>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vited/create",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Create and initialize Vited documentation projects",
   "keywords": [
     "cli",
@@ -27,6 +27,7 @@
   },
   "files": [
     "dist",
+    "favicon.svg",
     "CHANGELOG.md",
     "LICENSE",
     "README.md"
@@ -46,7 +47,6 @@
     "i18next": "^26.5.11"
   },
   "devDependencies": {
-    "@guoyunhe/editorconfig": "^0.3.0",
     "@guoyunhe/oxfmt-config": "^1.1.0",
     "@tsconfig/node20": "^20.1.2",
     "@tsconfig/strictest": "^2.0.2",