@dominikcz/greg 0.9.35 → 0.9.37

package/README.md

@@ -16,7 +16,7 @@ For unattended/default setup (no prompts):
 npx @dominikcz/greg init --defaults
 ```
 
-The interactive wizard will ask for docs path, site title, TypeScript preference, and the type of initial documentation (empty, sample, or generated fake docs). It can also install all required dependencies for you.
+The interactive wizard asks for docs path, site title, TypeScript preference, config mode (minimal or full), and starter docs type (empty, sample, or generated fake docs). It also creates a sensible `.gitignore`, copies default `public/` assets, and can install all required dependencies for you.
 
 At the end you only need:
 

package/bin/init.js

@@ -18,6 +18,7 @@ import { fork, spawnSync } from 'node:child_process';
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const cliArgs = new Set(process.argv.slice(2));
 const useDefaultsMode = cliArgs.has('--defaults') || cliArgs.has('--yes');
+const forceLocalDependency = cliArgs.has('--local-dependency') || process.env.GREG_INIT_LOCAL_DEP === '1';
 
 // ── ANSI helpers (used for file-creation log lines) ───────────────────────────
 const g = (s) => `\x1b[32m${s}\x1b[0m`;  // green
@@ -120,12 +121,7 @@ function isTransientCacheSpec(spec) {
 
 function resolveGregDependencySpec(version) {
     const packageRoot = join(__dirname, '..');
-    const npmView = spawnSync('npm', ['view', `@dominikcz/greg@${version}`, 'version'], {
-        stdio: 'pipe',
-        shell: true,
-    });
-
-    if (npmView.status === 0) {
+    if (!forceLocalDependency) {
         return { spec: `^${version}`, source: 'registry' };
     }
 
@@ -158,6 +154,7 @@ async function main() {
     let desc = 'Documentation';
     let useTS = true;
     let addScripts = true;
+    let fullConfig = false;
     let docsType = '1';
 
     if (!useDefaultsMode) {
@@ -166,6 +163,7 @@ async function main() {
         desc         = orCancel(await p.text({ message: 'Site description', initialValue: 'Documentation' }));
         useTS        = orCancel(await p.confirm({ message: 'Use TypeScript for configuration?', initialValue: true }));
         addScripts   = orCancel(await p.confirm({ message: 'Add greg scripts to package.json?', initialValue: true }));
+        fullConfig   = orCancel(await p.confirm({ message: 'Generate full greg.config template?', initialValue: false }));
         docsType     = orCancel(await p.select({
             message: 'Documentation contents',
             options: [
@@ -189,6 +187,9 @@ async function main() {
     const rootPath = '';
     const ext      = useTS ? 'ts' : 'js';
     const vars     = { TITLE: title, DESCRIPTION: desc, DOCS_DIR: docsDir, ROOT_PATH: rootPath, EXT: ext };
+    const gregConfigTemplate = useTS
+        ? (fullConfig ? 'greg.config.full.ts' : 'greg.config.ts')
+        : (fullConfig ? 'greg.config.full.js' : 'greg.config.js');
 
     p.log.step('Creating files…');
 
@@ -199,7 +200,14 @@ async function main() {
     ensure('src/app.css',          tpl('src/app.css'));
     ensure(`vite.config.${ext}`,   tpl('vite.config.js', vars)); // same content for .js and .ts
     ensure('svelte.config.js',     tpl('svelte.config.js'));     // always .js — vite-plugin-svelte requires it
-    ensure(`greg.config.${ext}`,   tpl(useTS ? 'greg.config.ts' : 'greg.config.js', vars));
+    ensure(`greg.config.${ext}`,   tpl(gregConfigTemplate, vars));
+    ensure('.gitignore',           tpl('gitignore'));
+    const packagePublicDir = join(__dirname, '..', 'public');
+    if (existsSync(packagePublicDir)) {
+        copyRawDir(packagePublicDir, 'public');
+    } else {
+        p.log.warn('public assets not found in package; skipping public/ scaffold');
+    }
 
     if (useTS) {
         ensure('tsconfig.json', tpl('tsconfig.json'));
@@ -244,7 +252,7 @@ async function main() {
                 let changed = false;
                 if (addScripts) {
                     pkg.scripts ??= {};
-                    for (const [k, v] of [['dev', 'greg dev'], ['build', 'greg build'], ['preview', 'greg preview']]) {
+                    for (const [k, v] of [['greg', 'greg'], ['dev', 'greg dev'], ['build', 'greg build'], ['preview', 'greg preview']]) {
                         if (!pkg.scripts[k]) { pkg.scripts[k] = v; changed = true; }
                     }
                 }
@@ -259,6 +267,18 @@ async function main() {
                     pkg.devDependencies['@dominikcz/greg'] = gregDependencySpec;
                     changed = true;
                 }
+                const peerDepsMap = {
+                    '@sveltejs/vite-plugin-svelte': gregDevDeps['@sveltejs/vite-plugin-svelte'] ?? '^6',
+                    svelte: gregDevDeps.svelte ?? '^5',
+                    vite: gregDevDeps.vite ?? '^7',
+                    ...(useTS ? { typescript: '^5' } : {}),
+                };
+                for (const [depName, depVersion] of Object.entries(peerDepsMap)) {
+                    if (!pkg.devDependencies[depName]) {
+                        pkg.devDependencies[depName] = depVersion;
+                        changed = true;
+                    }
+                }
                 if (changed) {
                     writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n', 'utf-8');
                     p.log.success('package.json  ' + d('(updated)'));
@@ -273,8 +293,14 @@ async function main() {
                 name: 'my-docs',
                 version: '0.0.1',
                 type: 'module',
-                ...(addScripts ? { scripts: { dev: 'greg dev', build: 'greg build', preview: 'greg preview' } } : {}),
-                devDependencies: { '@dominikcz/greg': gregDependencySpec },
+                ...(addScripts ? { scripts: { greg: 'greg', dev: 'greg dev', build: 'greg build', preview: 'greg preview' } } : {}),
+                devDependencies: {
+                    '@dominikcz/greg': gregDependencySpec,
+                    '@sveltejs/vite-plugin-svelte': gregDevDeps['@sveltejs/vite-plugin-svelte'] ?? '^6',
+                    svelte: gregDevDeps.svelte ?? '^5',
+                    vite: gregDevDeps.vite ?? '^7',
+                    ...(useTS ? { typescript: '^5' } : {}),
+                },
             };
             writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n', 'utf-8');
             console.log(`  ${g('+')} package.json`);
@@ -283,16 +309,8 @@ async function main() {
 
     // ── Install dependencies ──────────────────────────────────────────────────
     // @dominikcz/greg is already in package.json devDependencies — install only peer deps.
-    const peerDepsArr = [
-        `@sveltejs/vite-plugin-svelte@${gregDevDeps['@sveltejs/vite-plugin-svelte'] ?? '^6'}`,
-        `svelte@${gregDevDeps.svelte ?? '^5'}`,
-        `vite@${gregDevDeps.vite ?? '^7'}`,
-        ...(useTS ? ['typescript'] : []),
-    ];
     const pm = detectPm();
-    const installArgs = pm === 'npm'
-        ? ['install', '--save-dev', ...peerDepsArr]
-        : ['add', '-D', ...peerDepsArr];
+    const installArgs = ['install'];
 
     const installNow = useDefaultsMode
         ? true
@@ -325,8 +343,8 @@ async function main() {
 
     p.outro(
         installNow
-            ? `${b(g('Done!'))}  Start your project:\n\n  ${c('npm run dev')}`
-            : `${b(g('Done!'))}  Next steps:\n\n  ${c(`${pm} ${installArgs.join(' ')}`)}\n  ${c('npm run dev')}`
+            ? `${b(g('Done!'))}  Start your project:\n\n  ${c('npm run dev')}\n  ${c('npx greg --help')}`
+            : `${b(g('Done!'))}  Next steps:\n\n  ${c(`${pm} ${installArgs.join(' ')}`)}\n  ${c('npm run dev')}\n  ${c('npx greg --help')}`
     );
 }
 
@@ -346,6 +364,26 @@ function copyTemplateDir(srcDir, destRel, vars) {
     }
 }
 
+function copyRawDir(srcDir, destRel) {
+    for (const entry of readdirSync(srcDir)) {
+        const srcPath = join(srcDir, entry);
+        const destPath = join(destRel, entry);
+        if (statSync(srcPath).isDirectory()) {
+            copyRawDir(srcPath, destPath);
+        } else {
+            const full = join(cwd, destPath);
+            if (existsSync(full)) {
+                console.log(`  ${y('~')} ${destPath}  ${d('(skipped – already exists)')}`);
+                continue;
+            }
+            const dir = dirname(full);
+            if (!existsSync(dir)) mkdirSync(dir, { recursive: true });
+            writeFileSync(full, readFileSync(srcPath));
+            console.log(`  ${g('+')} ${destPath}`);
+        }
+    }
+}
+
 main().catch((err) => {
     console.error(err);
     process.exit(1);

package/bin/templates/gitignore

@@ -0,0 +1,13 @@
+node_modules/
+dist/
+.greg/
+
+# Logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# OS / editor
+.DS_Store
+Thumbs.db

package/bin/templates/greg.config.full.js

@@ -0,0 +1,32 @@
+/**
+ * @type {import('@dominikcz/greg').GregConfig}
+ */
+export default {
+    base: '/',
+    outDir: 'dist',
+    srcDir: '{{DOCS_DIR}}',
+    docsBase: '',
+    mainTitle: '{{TITLE}}',
+    useDynamicPageTitle: true,
+    sidebar: 'auto',
+    outline: [2, 3],
+    nav: [
+        { text: 'Guide', link: '/guide' },
+        { text: 'Reference', link: '/reference' },
+    ],
+    search: {
+        provider: 'local',
+        fuzzy: {
+            threshold: 0.35,
+            minMatchCharLength: 2,
+        },
+    },
+    // versioning: {
+    //     strategy: 'branches',
+    //     default: 'latest',
+    //     aliases: { latest: '1.0' },
+    //     branches: [
+    //         { version: '1.0', branch: 'main', title: '1.0' },
+    //     ],
+    // },
+}

package/bin/templates/greg.config.full.ts

@@ -0,0 +1,31 @@
+import type { GregConfig } from '@dominikcz/greg'
+
+export default {
+    base: '/',
+    outDir: 'dist',
+    srcDir: '{{DOCS_DIR}}',
+    docsBase: '',
+    mainTitle: '{{TITLE}}',
+    useDynamicPageTitle: true,
+    sidebar: 'auto',
+    outline: [2, 3],
+    nav: [
+        { text: 'Guide', link: '/guide' },
+        { text: 'Reference', link: '/reference' },
+    ],
+    search: {
+        provider: 'local',
+        fuzzy: {
+            threshold: 0.35,
+            minMatchCharLength: 2,
+        },
+    },
+    // versioning: {
+    //     strategy: 'branches',
+    //     default: 'latest',
+    //     aliases: { latest: '1.0' },
+    //     branches: [
+    //         { version: '1.0', branch: 'main', title: '1.0' },
+    //     ],
+    // },
+} satisfies GregConfig

package/bin/templates/greg.config.js

@@ -2,38 +2,14 @@
  * @type {import('@dominikcz/greg').GregConfig}
  */
 export default {
-    // VitePress-compatible build options:
-    // base: '/',
-    // outDir: 'dist',
-    srcDir: '',
-    docsBase: '',
+    base: '/',
+    outDir: 'dist',
+    srcDir: '{{DOCS_DIR}}',
     mainTitle: '{{TITLE}}',
+    // useDynamicPageTitle: true,
     sidebar: 'auto',
-    // versioning: {
-    //     strategy: 'branches', // default
-    //     default: 'latest',
-    //     aliases: {
-    //         latest: '2.1',
-    //         stable: '2.0',
-    //     },
-    //     ui: {
-    //         versionMenuLabel: 'Version',
-    //         manifestUnavailableText: 'Version selector unavailable',
-    //         showManifestUnavailableStatus: false,
-    //         outdatedVersionMessage: 'You are viewing an older version ({current}). Recommended: {default}.',
-    //         outdatedVersionActionLabel: 'Go to latest',
-    //     },
-    //     locales: {
-    //         '/': {
-    //             ui: { versionMenuLabel: 'Version' },
-    //         },
-    //         '/pl/': {
-    //             ui: { versionMenuLabel: 'Wersja' },
-    //         },
-    //     },
-    //     branches: [
-    //         { version: '2.1', branch: 'main', title: '2.1' },
-    //         { version: '2.0', branch: 'release/2.0', title: '2.0' },
-    //     ],
+    // search: {
+    //     provider: 'local',
+    //     // fuzzy: { threshold: 0.35, minMatchCharLength: 2 },
     // },
 }

package/bin/templates/greg.config.ts

@@ -1,38 +1,14 @@
 import type { GregConfig } from '@dominikcz/greg'
 
 export default {
-    // VitePress-compatible build options:
-    // base: '/',
-    // outDir: 'dist',
-    srcDir: '',
-    docsBase: '',
+    base: '/',
+    outDir: 'dist',
+    srcDir: '{{DOCS_DIR}}',
     mainTitle: '{{TITLE}}',
+    // useDynamicPageTitle: true,
     sidebar: 'auto',
-    // versioning: {
-    //     strategy: 'branches', // default
-    //     default: 'latest',
-    //     aliases: {
-    //         latest: '2.1',
-    //         stable: '2.0',
-    //     },
-    //     ui: {
-    //         versionMenuLabel: 'Version',
-    //         manifestUnavailableText: 'Version selector unavailable',
-    //         showManifestUnavailableStatus: false,
-    //         outdatedVersionMessage: 'You are viewing an older version ({current}). Recommended: {default}.',
-    //         outdatedVersionActionLabel: 'Go to latest',
-    //     },
-    //     locales: {
-    //         '/': {
-    //             ui: { versionMenuLabel: 'Version' },
-    //         },
-    //         '/pl/': {
-    //             ui: { versionMenuLabel: 'Wersja' },
-    //         },
-    //     },
-    //     branches: [
-    //         { version: '2.1', branch: 'main', title: '2.1' },
-    //         { version: '2.0', branch: 'release/2.0', title: '2.0' },
-    //     ],
+    // search: {
+    //     provider: 'local',
+    //     // fuzzy: { threshold: 0.35, minMatchCharLength: 2 },
     // },
 } satisfies GregConfig

package/docs/guide/getting-started.md

@@ -55,11 +55,13 @@ The wizard asks a handful of questions:
 | **Site title** | Shown in the browser tab and the site header |
 | **Description** | Used in the HTML `<meta>` tag |
 | **TypeScript** | Creates `.ts` config files instead of `.js` |
-| **Add npm scripts** | Adds `dev`, `build` and `preview` to `package.json` |
+| **Config mode** | Choose **minimal** (default) or **full** `greg.config` template |
+| **Add npm scripts** | Adds `greg`, `dev`, `build` and `preview` to `package.json` |
 | **Starter content** | _Empty_ — bare minimum; _Sample_ — example pages; _Generated_ — large fake docs set |
 | **Install now** | Runs `npm install` (or your package manager) right away |
 
 When it finishes, you will see a summary of created files.
+The scaffold also includes a default `.gitignore` and copies baseline assets into `public/`.
 
 ### 3. Start the development server
 

package/docs/reference/markdowndocs.md

@@ -133,6 +133,23 @@ Name of the project shown in the top-left header.
 <MarkdownDocs srcDir="/" version="1.0.0" mainTitle="My Project" />
 ```
 
+### `useDynamicPageTitle`
+
+- **Type:** `boolean`
+- **Default:** `true`
+
+Controls browser tab title behavior:
+
+- `true` (default): tab title follows active page title (for example `Getting Started | My Project`)
+- `false`: tab title stays fixed to `mainTitle`
+
+```js
+export default {
+  mainTitle: 'My Project',
+  useDynamicPageTitle: false,
+}
+```
+
 ### `outline`
 
 - **Type:** `false | number | [number, number] | 'deep' | { level?: …, label?: string }`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dominikcz/greg",
-  "version": "0.9.35",
+  "version": "0.9.37",
   "type": "module",
   "types": "./types/index.d.ts",
   "bin": {

package/src/lib/MarkdownDocs/MarkdownDocs.svelte

@@ -87,6 +87,8 @@
         children?: Snippet;
         version?: string;
         mainTitle?: string;
+        /** Keep browser tab title in sync with active page title. Default: true. */
+        useDynamicPageTitle?: boolean;
         carbonAds?: CarbonAdsOptions;
         /** VitePress-compatible outline option. false = disabled, [2,3] = default. */
         outline?: OutlineOption | boolean;
@@ -206,6 +208,7 @@
         ),
         version: globalVersion = (gregConfig as any).version ?? "",
         mainTitle: globalMainTitle = (gregConfig as any).mainTitle ?? "Greg",
+        useDynamicPageTitle = (gregConfig as any).useDynamicPageTitle ?? true,
         carbonAds = (gregConfig as any).carbonAds,
         outline: globalOutline =
             (gregConfig as any).outline ?? ([2, 3] as [number, number]),
@@ -1345,6 +1348,28 @@
     }
 
     const title = $derived(router.title(flat));
+    const browserTitle = $derived.by(() => {
+        if (!useDynamicPageTitle) {
+            const fixedTitle = String(mainTitle ?? "").trim();
+            return fixedTitle || "Greg";
+        }
+        const brand =
+            siteTitle === false
+                ? String(mainTitle || "").trim()
+                : String(siteTitle ?? mainTitle ?? "").trim();
+        const pageTitle = String(title ?? "").trim();
+        if (!brand) return pageTitle || "Greg";
+        if (!pageTitle || pageTitle === brand) return brand;
+        return `${pageTitle} | ${brand}`;
+    });
+
+    $effect(() => {
+        if (typeof document === "undefined") return;
+        if (!browserTitle) return;
+        if (document.title !== browserTitle) {
+            document.title = browserTitle;
+        }
+    });
 
     // -- Content fetch -----------------------------------------------------------
     async function fetchMarkdown(mdPath: string): Promise<string> {