sourcey 3.5.7 → 3.5.9

package/README.md

@@ -54,32 +54,28 @@ npx sourcey init
 
 ## Install
 
-### Sourcey
+### Sourcey CLI
 
-```bash
-npm install -g sourcey
-npx sourcey init
-```
+The full Sourcey binary handles OpenAPI, Doxygen, godoc, MCP, and Markdown sources.
 
-### Go docs generator
-
-```bash
-go install github.com/sourcey/sourcey/go/sourcey-godoc/cmd/sourcey-godoc@latest
-```
+| Path     | Command                                            | Requires          |
+|----------|----------------------------------------------------|-------------------|
+| npm      | `npm install -g sourcey`                           | Node 20+          |
+| Homebrew | `brew tap sourcey/tap && brew install sourcey`     | macOS / Linuxbrew |
+| Docker   | `docker run -v "$PWD":/docs sourcey/sourcey`       | Docker            |
+| Nix      | `nix run github:sourcey/sourcey`                   | Nix (flakes)      |
 
-### Homebrew (Go docs generator)
+Then `sourcey init` to scaffold a new project, or `sourcey build` against an existing one. See [docs/install.md](docs/install.md) for full Docker invocations (`init` / `dev` / `build`), the `--host` flag for containerized dev, Linuxbrew notes, and Nix profile install.
 
-```bash
-brew tap sourcey/tap
-brew install sourcey-godoc
-```
+### Standalone Go docs generator
 
-### Scoop (Go docs generator)
+For Go-only consumers without a JavaScript toolchain, `sourcey-godoc` ships as a separate native binary. It produces static Go docs sites or portable `godoc.json` snapshots.
 
-```powershell
-scoop bucket add sourcey https://github.com/sourcey/scoop-bucket
-scoop install sourcey-godoc
-```
+| Path     | Command |
+|----------|---------|
+| Go       | `go install github.com/sourcey/sourcey/go/sourcey-godoc/cmd/sourcey-godoc@latest` |
+| Homebrew | `brew install sourcey/tap/sourcey-godoc` |
+| Scoop    | `scoop bucket add sourcey https://github.com/sourcey/scoop-bucket && scoop install sourcey-godoc` |
 
 ## Quick start
 

package/dist/cli.js

@@ -110,6 +110,11 @@ const dev = defineCommand({
             description: "Port to listen on",
             default: "4400",
         },
+        host: {
+            type: "string",
+            description: "Address to bind to (e.g. 0.0.0.0 to expose externally; defaults to 127.0.0.1, or $HOST if set)",
+            required: false,
+        },
         config: {
             type: "string",
             alias: ["c"],
@@ -126,6 +131,7 @@ const dev = defineCommand({
         const { startDevServer } = await import("./dev-server.js");
         await startDevServer({
             port: parseInt(args.port, 10),
+            host: args.host ?? process.env.HOST,
             config: args.config,
             strictChangelog: args.strictChangelog,
         });

package/dist/components/changelog/ChangelogPage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChangelogPage.d.ts","sourceRoot":"","sources":["../../../src/components/changelog/ChangelogPage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAGxF,wBAAgB,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,gCAyBlE"}
+{"version":3,"file":"ChangelogPage.d.ts","sourceRoot":"","sources":["../../../src/components/changelog/ChangelogPage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,IAAI,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAIxF,wBAAgB,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,iBAAiB,CAAA;CAAE,gCA4BlE"}

package/dist/components/changelog/ChangelogPage.js

@@ -1,8 +1,9 @@
 import { jsx as _jsx, jsxs as _jsxs } from "preact/jsx-runtime";
+import { renderMarkdownInline } from "../../utils/markdown.js";
 import { VersionCard } from "./VersionCard.js";
 export function ChangelogPage({ page }) {
     const versions = page.permalinkVersionId
         ? page.changelog.versions.filter((version) => version.id === page.permalinkVersionId)
         : page.changelog.versions;
-    return (_jsxs("div", { class: "sourcey-changelog-page", children: [_jsxs("header", { class: "sourcey-changelog-header", children: [_jsx("div", { class: "mt-0.5 space-y-2.5", children: _jsx("h1", { class: "text-2xl sm:text-3xl text-[rgb(var(--color-gray-900))] tracking-tight dark:text-[rgb(var(--color-gray-200))] font-bold", style: "overflow-wrap: anywhere", children: page.title }) }), page.description && (_jsx("p", { class: "sourcey-changelog-description", children: page.description }))] }), _jsx("div", { class: "sourcey-changelog-list", children: versions.map((version) => (_jsx(VersionCard, { version: version }, version.id))) })] }));
+    return (_jsxs("div", { class: "sourcey-changelog-page", children: [_jsxs("header", { class: "sourcey-changelog-header", children: [_jsx("div", { class: "mt-0.5 space-y-2.5", children: _jsx("h1", { class: "text-2xl sm:text-3xl text-[rgb(var(--color-gray-900))] tracking-tight dark:text-[rgb(var(--color-gray-200))] font-bold", style: "overflow-wrap: anywhere", children: page.title }) }), page.description && (_jsx("p", { class: "sourcey-changelog-description", dangerouslySetInnerHTML: { __html: renderMarkdownInline(page.description) } }))] }), _jsx("div", { class: "sourcey-changelog-list", children: versions.map((version) => (_jsx(VersionCard, { version: version }, version.id))) })] }));
 }

package/dist/components/changelog/VersionCard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"VersionCard.d.ts","sourceRoot":"","sources":["../../../src/components/changelog/VersionCard.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAoBtE,wBAAgB,WAAW,CAAC,EAC1B,OAAO,EACP,aAAa,GACd,EAAE;IACD,OAAO,EAAE,0BAA0B,CAAC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,gCAuCA"}
+{"version":3,"file":"VersionCard.d.ts","sourceRoot":"","sources":["../../../src/components/changelog/VersionCard.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AAoBtE,wBAAgB,WAAW,CAAC,EAC1B,OAAO,EACP,aAAa,GACd,EAAE;IACD,OAAO,EAAE,0BAA0B,CAAC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,gCA4CA"}

package/dist/components/changelog/VersionCard.js

@@ -21,5 +21,7 @@ export function VersionCard({ version, permalinkHref, }) {
     const href = permalinkHref ?? `#${version.id}`;
     const label = version.version ?? "Unreleased";
     const formattedDate = formatDate(version.date);
-    return (_jsxs("article", { id: version.id, class: `sourcey-changelog-version${version.version ? "" : " sourcey-changelog-version-unreleased"}`, children: [_jsxs("header", { class: "sourcey-changelog-version-header", children: [_jsxs("div", { class: "sourcey-changelog-version-heading", children: [_jsx("a", { href: href, class: "sourcey-changelog-version-link", children: label }), version.yanked && _jsx("span", { class: "sourcey-changelog-pill sourcey-changelog-pill-yanked", children: "YANKED" }), version.prerelease && _jsx("span", { class: "sourcey-changelog-pill sourcey-changelog-pill-pre", children: "pre" })] }), _jsxs("div", { class: "sourcey-changelog-version-meta", children: [formattedDate && _jsx("time", { dateTime: version.date ?? undefined, children: formattedDate }), version.compareUrl && (_jsx("a", { href: version.compareUrl, target: "_blank", rel: "noopener noreferrer", class: "sourcey-changelog-compare-link", children: "Compare" }))] })] }), version.summary && _jsx(Markdown, { content: version.summary, class: "sourcey-changelog-summary" }), _jsx("div", { class: "sourcey-changelog-sections", children: version.sections.map((section) => (_jsxs("section", { class: "sourcey-changelog-section", children: [_jsx("div", { class: "sourcey-changelog-section-header", children: _jsx(TypeBadge, { type: section.type, label: section.label }) }), _jsx(EntryList, { entries: section.entries })] }, `${version.id}-${section.label}`))) })] }));
+    const isUnreleased = !version.version;
+    const hasMeta = isUnreleased || formattedDate || version.compareUrl;
+    return (_jsxs("article", { id: version.id, class: `sourcey-changelog-version${isUnreleased ? " sourcey-changelog-version-unreleased" : ""}`, children: [_jsxs("header", { class: "sourcey-changelog-version-header", children: [_jsxs("div", { class: "sourcey-changelog-version-heading", children: [_jsx("a", { href: href, class: "sourcey-changelog-version-link", children: label }), version.yanked && _jsx("span", { class: "sourcey-changelog-pill sourcey-changelog-pill-yanked", children: "YANKED" }), version.prerelease && _jsx("span", { class: "sourcey-changelog-pill sourcey-changelog-pill-pre", children: "pre" })] }), hasMeta && (_jsxs("div", { class: "sourcey-changelog-version-meta", children: [isUnreleased && _jsx("span", { class: "sourcey-changelog-pill sourcey-changelog-pill-next", children: "Next release" }), formattedDate && _jsx("time", { dateTime: version.date ?? undefined, children: formattedDate }), version.compareUrl && (_jsx("a", { href: version.compareUrl, target: "_blank", rel: "noopener noreferrer", class: "sourcey-changelog-compare-link", children: "Compare" }))] }))] }), version.summary && _jsx(Markdown, { content: version.summary, class: "sourcey-changelog-summary" }), _jsx("div", { class: "sourcey-changelog-sections", children: version.sections.map((section) => (_jsxs("section", { class: "sourcey-changelog-section", children: [_jsx("div", { class: "sourcey-changelog-section-header", children: _jsx(TypeBadge, { type: section.type, label: section.label }) }), _jsx(EntryList, { entries: section.entries })] }, `${version.id}-${section.label}`))) })] }));
 }

package/dist/core/changelog-normalizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"changelog-normalizer.d.ts","sourceRoot":"","sources":["../../src/core/changelog-normalizer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAMV,mBAAmB,EAIpB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAuDD,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,yBAA8B,GACtC,mBAAmB,CA4HrB"}
+{"version":3,"file":"changelog-normalizer.d.ts","sourceRoot":"","sources":["../../src/core/changelog-normalizer.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAMV,mBAAmB,EAIpB,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAuDD,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,yBAA8B,GACtC,mBAAmB,CA8HrB"}

package/dist/core/changelog-normalizer.js

@@ -36,6 +36,7 @@ export function normalizeChangelog(markdown, options = {}) {
     const descriptionParts = [];
     const rawBlocks = [];
     let currentBlock = null;
+    let seenFirstVersionHeading = false;
     for (const token of tokens) {
         if (token.type === "heading") {
             const heading = token;
@@ -48,6 +49,7 @@ export function normalizeChangelog(markdown, options = {}) {
                 if (currentBlock)
                     rawBlocks.push(currentBlock);
                 currentBlock = null;
+                seenFirstVersionHeading = true;
                 const parsed = parseVersionHeading(text);
                 if (!parsed) {
                     diagnostics.push({
@@ -72,7 +74,7 @@ export function normalizeChangelog(markdown, options = {}) {
         if (currentBlock) {
             appendTokenToVersion(token, currentBlock, diagnostics, options.repoUrl);
         }
-        else if (!options.description && shouldContributeToDescription(token)) {
+        else if (!options.description && !seenFirstVersionHeading && shouldContributeToDescription(token)) {
             descriptionParts.push(token.raw);
         }
     }

package/dist/dev-server.d.ts

@@ -1,5 +1,6 @@
 export interface DevServerOptions {
     port: number;
+    host?: string;
     config?: string;
     strictChangelog?: boolean;
 }

package/dist/dev-server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dev-server.d.ts","sourceRoot":"","sources":["../src/dev-server.ts"],"names":[],"mappings":"AA+CA,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,wBAAsB,cAAc,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuZ7E"}
+{"version":3,"file":"dev-server.d.ts","sourceRoot":"","sources":["../src/dev-server.ts"],"names":[],"mappings":"AA+CA,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,wBAAsB,cAAc,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAyZ7E"}

package/dist/dev-server.js

@@ -37,7 +37,7 @@ function shortPath(path) {
     return relative(process.cwd(), path) || basename(path);
 }
 export async function startDevServer(options) {
-    const { port } = options;
+    const { port, host } = options;
     let config = await loadConfig(options.config);
     const configPath = options.config?.endsWith(".ts")
         ? resolve(options.config)
@@ -328,6 +328,7 @@ export async function startDevServer(options) {
         root: process.cwd(),
         server: {
             port,
+            host,
             strictPort: true,
             hmr: true,
             fs: {
@@ -382,7 +383,8 @@ export async function startDevServer(options) {
         });
     });
     await vite.listen();
-    console.log(`\n  Sourcey dev server running at http://localhost:${port}${config.baseUrl || "/"}`);
+    const displayHost = !host || host === "127.0.0.1" || host === "localhost" ? "localhost" : host;
+    console.log(`\n  Sourcey dev server running at http://${displayHost}:${port}${config.baseUrl || "/"}`);
     console.log(`  Watching: ${watchPaths.length} content file${watchPaths.length === 1 ? "" : "s"} + components + CSS (HMR)`);
     console.log(`  Press Ctrl+C to stop\n`);
     fullRebuild().catch((err) => {

package/dist/site-url.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"site-url.d.ts","sourceRoot":"","sources":["../src/site-url.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAMzD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAoBrE;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,SAAK,EAAE,UAAU,GAAE,UAAkB,GAAG,MAAM,CAsBrG;AAED,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAK1E;AAED,wBAAgB,WAAW,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,SAAK,EACZ,UAAU,GAAE,UAAkB,GAC7B,MAAM,CAER;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,SAAK,GAAG,MAAM,CAcnE"}
+{"version":3,"file":"site-url.d.ts","sourceRoot":"","sources":["../src/site-url.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAMzD;AAED,wBAAgB,gBAAgB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAoBrE;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,SAAK,EAAE,UAAU,GAAE,UAAkB,GAAG,MAAM,CAyBrG;AAED,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAK1E;AAED,wBAAgB,WAAW,CACzB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,SAAK,EACZ,UAAU,GAAE,UAAkB,GAC7B,MAAM,CAER;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,SAAK,GAAG,MAAM,CAcnE"}

package/dist/site-url.js

@@ -32,6 +32,9 @@ export function toPublicPath(outputPath, baseUrl = "", prettyUrls = false) {
     const prefix = normalizedBase || "/";
     const cleanOutputPath = outputPath.replace(/^\/+/, "");
     if (!cleanOutputPath || cleanOutputPath === "index.html") {
+        if (prettyUrls === "strip" && normalizedBase) {
+            return normalizedBase.slice(0, -1);
+        }
         return prefix;
     }
     if (cleanOutputPath.endsWith("/index.html")) {

package/dist/themes/default/sourcey.css

@@ -882,12 +882,46 @@ h1[id], h2[id], h3[id], h4[id], h5[id], h6[id] {
   font-size: 1.05rem;
   line-height: 1.7;
   color: rgb(var(--color-gray-600));
+  max-width: 65ch;
+  text-wrap: pretty;
 }
 
 .dark #sourcey .sourcey-changelog-description {
   color: rgb(var(--color-gray-400));
 }
 
+#sourcey .sourcey-changelog-description a {
+  color: rgb(var(--color-primary-ink));
+  text-decoration: none;
+  border-bottom: 1px solid rgb(var(--color-primary-ink) / 0.3);
+}
+
+#sourcey .sourcey-changelog-description a:hover {
+  border-bottom-color: rgb(var(--color-primary-ink));
+}
+
+.dark #sourcey .sourcey-changelog-description a {
+  color: rgb(var(--color-primary-light));
+  border-bottom-color: rgb(var(--color-primary-light) / 0.3);
+}
+
+.dark #sourcey .sourcey-changelog-description a:hover {
+  border-bottom-color: rgb(var(--color-primary-light));
+}
+
+#sourcey .sourcey-changelog-description code {
+  font-size: 0.92em;
+  padding: 0.05rem 0.3rem;
+  border-radius: 0.25rem;
+  background: rgb(var(--color-gray-100));
+  color: rgb(var(--color-gray-800));
+}
+
+.dark #sourcey .sourcey-changelog-description code {
+  background: rgb(255 255 255 / 0.08);
+  color: rgb(var(--color-gray-200));
+}
+
 #sourcey .sourcey-changelog-list {
   display: flex;
   flex-direction: column;
@@ -907,7 +941,16 @@ h1[id], h2[id], h3[id], h4[id], h5[id], h6[id] {
 }
 
 #sourcey .sourcey-changelog-version-unreleased {
-  border-style: dashed;
+  border-color: rgb(var(--color-primary) / 0.18);
+  border-left: 3px solid rgb(var(--color-primary));
+  padding-left: calc(1.25rem - 2px);
+  background: linear-gradient(180deg, rgb(var(--color-primary) / 0.04), rgb(var(--color-primary) / 0.015));
+}
+
+.dark #sourcey .sourcey-changelog-version-unreleased {
+  border-color: rgb(var(--color-primary-light) / 0.22);
+  border-left-color: rgb(var(--color-primary-light));
+  background: linear-gradient(180deg, rgb(var(--color-primary-light) / 0.06), rgb(var(--color-primary-light) / 0.02));
 }
 
 #sourcey .sourcey-changelog-version-header {
@@ -1001,6 +1044,19 @@ h1[id], h2[id], h3[id], h4[id], h5[id], h6[id] {
   color: rgb(var(--color-gray-300));
 }
 
+#sourcey .sourcey-changelog-pill-next {
+  background: rgb(var(--color-primary) / 0.1);
+  color: rgb(var(--color-primary-ink));
+  text-transform: uppercase;
+  letter-spacing: 0.06em;
+  font-size: 0.68rem;
+}
+
+.dark #sourcey .sourcey-changelog-pill-next {
+  background: rgb(var(--color-primary-light) / 0.14);
+  color: rgb(var(--color-primary-light));
+}
+
 #sourcey .sourcey-changelog-summary {
   margin-bottom: 1rem;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sourcey",
-  "version": "3.5.7",
+  "version": "3.5.9",
   "description": "Precision documentation from OpenAPI, MCP, Doxygen, godoc, and Markdown. Static HTML you own.",
   "type": "module",
   "engines": {