getfilepress 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Catalyst Forge LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,9 +1,183 @@
 # FilePress
 
-**Placeholder package (`getfilepress@0.0.0`).**
+> File-based Markdown blogs. No admin UI. No database. Just git.
 
-File-based Markdown blogs are on the way.
+A file-based Markdown blog engine. Posts are plain `.md` files with YAML frontmatter — edit them in the GitHub mobile app, the web editor, or any text editor. There is no admin UI, no database, and no server at runtime: a static build produces HTML you can host anywhere (e.g. Cloudflare Pages).
 
-- Engine: [https://github.com/Catalyst-Forge-LLC/filepress](https://github.com/Catalyst-Forge-LLC/filepress)
+| | |
+| --- | --- |
+| **Site** | [https://getfilepress.com](https://getfilepress.com) |
+| **npm** | [`getfilepress`](https://www.npmjs.com/package/getfilepress) |
+| **CLI** | `filepress` (also `getfilepress`) |
 
-Do not depend on this version in production.
+## Requirements
+
+- Node.js 20+
+- [pnpm](https://pnpm.io)
+
+## Quick start (new site)
+
+From a clone of this repo:
+
+```bash
+pnpm install
+pnpm create-site my-blog --external ../my-blog --title "My Blog" --url https://my.blog
+
+cd ../my-blog
+pnpm install
+pnpm dev      # local preview (Genie Mode FAB in the corner)
+pnpm build    # → build/
+```
+
+The site folder only needs:
+
+- `filepress.config.ts` — title, URL, and other site settings
+- `posts/` — Markdown posts (`/posts/<slug>`)
+- `pages/` — optional static Markdown pages (`about.md` → `/about`)
+- `static/` — favicon, images, etc.
+- `package.json` — depends on this engine (`"getfilepress": "link:../filepress"` locally, `"getfilepress": "^0.1.0"` from npm, or a git URL + tag/SHA)
+
+### Import an existing site
+
+Crawl a public site (sitemap/RSS preferred), extract posts and pages, scaffold a sibling FilePress site, and optionally ask a local Ollama model for a token theme:
+
+```bash
+pnpm install
+pnpm filepress import --source https://example.com \
+  --inspire https://www.catalystforge.com \
+  --inspire https://app.execfoundry.com/start \
+  --yes
+
+# up to 3 --inspire URLs; signals are blended (first biases structure, later ones tint accent/fonts)
+
+# dry-run first (no write):
+pnpm filepress import --source https://example.com --dry-run --no-llm
+```
+
+See [`docs/SITE_IMPORT_SPEC.md`](docs/SITE_IMPORT_SPEC.md).
+
+More detail: [`docs/EXTERNAL_SITES.md`](docs/EXTERNAL_SITES.md).
+
+### In this repo
+
+- `sites/demo` — engine fixture (drafts, scheduled posts, frontmatter cheatsheet). Root `pnpm check` / `pnpm build` target this site.
+- `sites/getfilepress` — product site for getfilepress.com (`homePage` landing + Writing). Sibling publications live in their own repos.
+
+```bash
+pnpm install
+pnpm dev                 # → demo fixture
+pnpm build               # → sites/demo/build/
+pnpm dev:www             # → product site
+pnpm build:www           # → sites/getfilepress/build/
+pnpm deploy:www          # build + Wrangler Pages deploy (project: getfilepress)
+```
+
+## Site configuration
+
+```ts
+import { defineFilepressConfig } from 'getfilepress';
+
+export default defineFilepressConfig({
+  title: 'My Site',
+  description: 'A short site description.',
+  url: 'https://my.site', // required; canonical origin, no trailing slash
+  author: 'Me',
+  postsPerPage: 10,
+  topics: [{ label: 'Essays', tag: 'essays' }],
+  newsletter: {
+    url: 'https://buttondown.email/me',
+    blurb: 'Occasional notes.',
+    cta: 'Subscribe'
+  }
+});
+```
+
+`title` and `url` are required; missing values fail the build with a clear error.
+
+## Theming
+
+The engine ships a default Essay look. To restyle a site, add `theme.css` next to
+`filepress.config.ts`. It loads after the default theme, so you can override CSS
+variables and structural classes without forking the app.
+
+In local `pnpm dev`, **Genie Mode** lets you steer tokens, stock backgrounds, and
+versioned theme activations without leaving the browser (dev-only; not in production builds).
+
+```css
+/* theme.css */
+:root {
+  --accent: #1e4d6b;
+  --accent-strong: #163a52;
+}
+```
+
+Token and class reference: [`docs/THEME.md`](docs/THEME.md).
+
+## Writing a post
+
+Add a file under the site's `posts/` directory:
+
+```markdown
+---
+title: "My Post"
+date: 2026-07-04
+description: A short summary used in listings and SEO.
+tags: [notes]
+author: Jane Roe
+draft: false
+updated: 2026-07-05
+---
+
+Body content in **Markdown**.
+```
+
+| Field | Required | Notes |
+| --- | --- | --- |
+| `title` | yes | Build fails (naming the file) if missing. |
+| `date` | yes | Strict `YYYY-MM-DD`. Future-dated posts stay hidden until that date. |
+| `slug` | no | Derived from the filename if omitted. |
+| `description` / `excerpt` | no | Listings and meta tags. |
+| `tags` | no | YAML list; lowercased and de-duplicated. |
+| `author` | no | Per-post byline; omit on single-author sites. |
+| `draft` | no | Hidden from production listings/feeds/sitemap; still builds at its URL. Listed with a Draft label under `pnpm dev` (localhost). |
+| `updated` | no | Shown when different from `date`. |
+
+**Images:** put files in `static/images/posts/<slug>/` and reference them as `/images/posts/<slug>/photo.jpg`.
+
+**Captions:** an image alone on a line becomes a `<figure>`; the title attribute is the caption:
+
+```markdown
+![alt text](/images/posts/my-post/photo.jpg "Caption under the image")
+```
+
+## Deploy
+
+Build output is a static folder. For a site that depends on this engine:
+
+| Setting | Value |
+| --- | --- |
+| Build command | `pnpm install && pnpm build` |
+| Output directory | `build` |
+
+Point the site's dependency at a pinned commit or tag of this repo (not a floating branch) so upgrades are intentional. If this engine repo is private, the host's build needs permission to clone it.
+
+More at [getfilepress.com](https://getfilepress.com).
+
+## Repository layout
+
+```
+packages/core     shared engine (content pipeline, components, theme)
+packages/app      SvelteKit app (routes + Genie Mode in dev) used by the CLI
+packages/import   site crawl / scaffold CLI (also powers Genie theme helpers)
+sites/demo        engine fixture content
+sites/getfilepress product site (getfilepress.com)
+scripts/          filepress CLI and create-site scaffold
+```
+
+```bash
+pnpm test    # engine unit tests
+```
+
+## License
+
+MIT — see [LICENSE](LICENSE).

package/package.json

@@ -1,18 +1,100 @@
 {
 	"name": "getfilepress",
-	"version": "0.0.0",
-	"description": "Placeholder — FilePress is coming soon.",
-	"license": "MIT",
+	"version": "0.1.0",
 	"private": false,
 	"type": "module",
+	"description": "FilePress — file-based Markdown blog engine. Link this package from a content-only site (config + posts), then run `filepress build`.",
+	"license": "MIT",
+	"homepage": "https://getfilepress.com",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/Catalyst-Forge-LLC/filepress.git"
 	},
-	"author": "Catalyst Forge LLC",
-	"keywords": ["markdown", "blog", "static-site", "sveltekit", "git", "filepress"],
-	"files": ["README.md"],
+	"bugs": {
+		"url": "https://github.com/Catalyst-Forge-LLC/filepress/issues"
+	},
+	"bin": {
+		"filepress": "./scripts/filepress.mjs",
+		"getfilepress": "./scripts/filepress.mjs"
+	},
+	"exports": {
+		".": {
+			"types": "./packages/core/src/lib/index.ts",
+			"svelte": "./packages/core/src/lib/index.ts",
+			"default": "./packages/core/src/lib/index.ts"
+		},
+		"./server": {
+			"types": "./packages/core/src/lib/server.ts",
+			"default": "./packages/core/src/lib/server.ts"
+		},
+		"./theme": {
+			"default": "./packages/core/src/lib/theme.ts"
+		},
+		"./package.json": "./package.json"
+	},
+	"files": [
+		"scripts/filepress.mjs",
+		"scripts/create-site.mjs",
+		"scripts/postinstall.mjs",
+		"scripts/link-embedded-packages.mjs",
+		"packages/core",
+		"packages/app",
+		"packages/import",
+		"pnpm-workspace.yaml",
+		"README.md",
+		"LICENSE"
+	],
 	"scripts": {
-		"postinstall": "node -e \"console.log('getfilepress: reserved placeholder (0.0.0). FilePress coming soon.')\""
+		"postinstall": "node scripts/postinstall.mjs",
+		"filepress": "node scripts/filepress.mjs",
+		"test": "pnpm --filter @filepress/core test && pnpm --filter @filepress/import test",
+		"check": "pnpm filepress check --site demo",
+		"build": "pnpm filepress build --site demo",
+		"build:demo": "pnpm filepress build --site demo",
+		"build:www": "pnpm filepress build --site getfilepress",
+		"deploy:www": "pnpm build:www && wrangler pages deploy sites/getfilepress/build --project-name getfilepress",
+		"dev": "pnpm filepress dev --site demo",
+		"dev:demo": "pnpm filepress dev --site demo",
+		"dev:www": "pnpm filepress dev --site getfilepress",
+		"create-site": "node scripts/create-site.mjs",
+		"import": "node scripts/filepress.mjs import",
+		"prepack": "node scripts/prepack.mjs",
+		"postpack": "node scripts/postpack.mjs",
+		"pack:smoke": "node scripts/pack-smoke.mjs"
+	},
+	"dependencies": {
+		"@fontsource-variable/inter": "^5.2.8",
+		"@fontsource-variable/newsreader": "^5.2.10",
+		"@sveltejs/adapter-static": "^3.0.10",
+		"@sveltejs/kit": "^2.63.0",
+		"@sveltejs/vite-plugin-svelte": "^7.1.2",
+		"@types/turndown": "^5.0.5",
+		"fast-xml-parser": "^5.2.5",
+		"gray-matter": "^4.0.3",
+		"highlight.js": "^11.11.1",
+		"linkedom": "^0.18.12",
+		"rehype-autolink-headings": "^7.1.0",
+		"rehype-highlight": "^7.0.2",
+		"rehype-raw": "^7.0.0",
+		"rehype-slug": "^6.0.0",
+		"rehype-stringify": "^10.0.1",
+		"remark-gfm": "^4.0.1",
+		"remark-parse": "^11.0.0",
+		"remark-rehype": "^11.1.2",
+		"sirv-cli": "^3.0.1",
+		"svelte": "^5.56.1",
+		"svelte-check": "^4.6.0",
+		"tsx": "^4.20.5",
+		"turndown": "^7.2.1",
+		"typescript": "^6.0.3",
+		"unified": "^11.0.5",
+		"vite": "^8.0.16"
+	},
+	"engines": {
+		"node": ">=20"
+	},
+	"packageManager": "pnpm@10.30.1",
+	"devDependencies": {
+		"wrangler": "^4.120.1"
 	}
 }

package/packages/app/package.json

@@ -0,0 +1,31 @@
+{
+	"name": "@filepress/app",
+	"private": true,
+	"version": "0.1.0",
+	"type": "module",
+	"description": "The single SvelteKit app for filepress. Sites under sites/* supply config + posts + static; this package owns all routes.",
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build",
+		"preview": "vite preview",
+		"prepare": "svelte-kit sync || echo ''",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"test": "vitest run --config vitest.config.ts"
+	},
+	"dependencies": {
+		"@filepress/core": "workspace:*",
+		"@filepress/import": "workspace:*"
+	},
+	"devDependencies": {
+		"@sveltejs/adapter-static": "^3.0.10",
+		"@sveltejs/kit": "^2.63.0",
+		"@sveltejs/vite-plugin-svelte": "^7.1.2",
+		"@types/node": "^26.1.0",
+		"sirv-cli": "^3.0.1",
+		"svelte": "^5.56.1",
+		"svelte-check": "^4.6.0",
+		"typescript": "^6.0.3",
+		"vite": "^8.0.16",
+		"vitest": "^4.1.9"
+	}
+}

package/packages/app/src/app.d.ts

@@ -0,0 +1,12 @@
+// See https://svelte.dev/docs/kit/types#app.d.ts
+declare global {
+	namespace App {
+		// interface Error {}
+		// interface Locals {}
+		// interface PageData {}
+		// interface PageState {}
+		// interface Platform {}
+	}
+}
+
+export {};

package/packages/app/src/app.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<meta name="text-scale" content="scale" />
+		%sveltekit.head%
+	</head>
+	<body data-sveltekit-preload-data="hover">
+		<div style="display: contents">%sveltekit.body%</div>
+	</body>
+</html>

package/packages/app/src/critical-theme.d.ts

@@ -0,0 +1,4 @@
+declare module '$critical-theme' {
+	const css: string;
+	export default css;
+}

package/packages/app/src/lib/content.server.ts

@@ -0,0 +1,8 @@
+import { createContent } from '@filepress/core/server';
+import { getContentDir } from './site.server';
+
+// Bound to the active site's posts/ (or FILEPRESS_CONTENT_DIR). Resolved at
+// module load from FILEPRESS_SITE_ROOT set by scripts/filepress.mjs.
+export const content = createContent({
+	contentDir: getContentDir()
+});

package/packages/app/src/lib/empty-theme.css

@@ -0,0 +1 @@
+/* Intentionally empty — used when the site has no theme.css / theme.scss. */

package/packages/app/src/lib/genie/GenieHost.svelte

@@ -0,0 +1,16 @@
+<script lang="ts">
+	/**
+	 * Mount Genie only in Vite DEV. Dynamic import keeps the panel out of
+	 * production client graphs when this host is tree-shaken / dead-coded.
+	 */
+	const enabled =
+		import.meta.env.DEV ||
+		import.meta.env.FILEPRESS_GENIE === '1' ||
+		import.meta.env.FILEPRESS_GENIE === 'true';
+</script>
+
+{#if enabled}
+	{#await import('./GeniePanel.svelte') then { default: GeniePanel }}
+		<GeniePanel />
+	{/await}
+{/if}