getfilepress 0.1.0 → 0.1.2

package/README.md

@@ -35,7 +35,7 @@ The site folder only needs:
 - `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)
+- `package.json` — depends on this engine (`"getfilepress": "link:../filepress"` locally, `"getfilepress": "^0.1.1"` from npm, or a git URL + tag/SHA)
 
 ### Import an existing site
 
@@ -84,6 +84,15 @@ export default defineFilepressConfig({
   author: 'Me',
   postsPerPage: 10,
   topics: [{ label: 'Essays', tag: 'essays' }],
+  nav: [
+    { label: 'Posts', href: '/' },
+    { label: 'GitHub', href: 'https://github.com/acme/site', icon: 'github' }
+  ],
+  // Replaces the default RSS + Topics row when set.
+  footerLinks: [
+    { label: 'RSS', href: '/rss.xml' },
+    { label: 'GitHub', href: 'https://github.com/acme/site', icon: 'github' }
+  ],
   newsletter: {
     url: 'https://buttondown.email/me',
     blurb: 'Occasional notes.',
@@ -92,7 +101,7 @@ export default defineFilepressConfig({
 });
 ```
 
-`title` and `url` are required; missing values fail the build with a clear error.
+`title` and `url` are required; missing values fail the build with a clear error. Nav/footer items may set `icon: 'github'` for a built-in mark.
 
 ## Theming
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "getfilepress",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"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`.",

package/packages/app/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@filepress/app",
 	"private": true,
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"type": "module",
 	"description": "The single SvelteKit app for filepress. Sites under sites/* supply config + posts + static; this package owns all routes.",
 	"scripts": {

package/packages/core/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@filepress/core",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"private": true,
 	"type": "module",
 	"description": "Reusable engine for filepress sites: content loader, Markdown pipeline, feed/sitemap builders, config helper, Essay theme, and shared Svelte components.",

package/packages/core/src/lib/components/NavIcon.svelte

@@ -0,0 +1,19 @@
+<script lang="ts">
+	import type { NavIconName } from '../config';
+
+	let { name }: { name: NavIconName } = $props();
+</script>
+
+{#if name === 'github'}
+	<svg class="nav-icon" viewBox="0 0 16 16" width="16" height="16" aria-hidden="true" focusable="false">
+		<path
+			fill="currentColor"
+			d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38
+			0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01
+			1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95
+			0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27s1.36.09 2 .27c1.53-1.04
+			2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48
+			0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8z"
+		/>
+	</svg>
+{/if}

package/packages/core/src/lib/components/SiteFooter.svelte

@@ -1,5 +1,6 @@
 <script lang="ts">
 	import type { SiteConfig } from '../config';
+	import NavIcon from './NavIcon.svelte';
 
 	let { site, year = new Date().getFullYear() }: { site: SiteConfig; year?: number } = $props();
 </script>
@@ -8,8 +9,21 @@
 	<div class="wrap">
 		<span>&copy; {year} {site.author}</span>
 		<span class="footer-links">
-			<a href="/rss.xml">RSS</a>
-			<a href="/topics">Topics</a>
+			{#each site.footerLinks as item (item.href)}
+				<a
+					href={item.href}
+					class:has-icon={Boolean(item.icon)}
+					class:nav-github={item.icon === 'github'}
+					{...(item.icon === 'github'
+						? { target: '_blank', rel: 'noopener noreferrer' }
+						: {})}
+				>
+					{#if item.icon}
+						<NavIcon name={item.icon} />
+					{/if}
+					<span class="nav-label">{item.label}</span>
+				</a>
+			{/each}
 		</span>
 	</div>
 </footer>

package/packages/core/src/lib/components/SiteHeader.svelte

@@ -1,5 +1,6 @@
 <script lang="ts">
 	import type { SiteConfig } from '../config';
+	import NavIcon from './NavIcon.svelte';
 
 	let { site }: { site: SiteConfig } = $props();
 </script>
@@ -21,7 +22,19 @@
 		</div>
 		<nav class="site-nav" aria-label="Primary">
 			{#each site.nav as item (item.href)}
-				<a href={item.href}>{item.label}</a>
+				<a
+					href={item.href}
+					class:has-icon={Boolean(item.icon)}
+					class:nav-github={item.icon === 'github'}
+					{...(item.icon === 'github'
+						? { target: '_blank', rel: 'noopener noreferrer' }
+						: {})}
+				>
+					{#if item.icon}
+						<NavIcon name={item.icon} />
+					{/if}
+					<span class="nav-label">{item.label}</span>
+				</a>
 			{/each}
 		</nav>
 	</div>

package/packages/core/src/lib/config.ts

@@ -22,9 +22,14 @@ export interface Topic {
 	tag: string;
 }
 
+/** Built-in icons that chrome can render beside a nav/footer label. */
+export type NavIconName = 'github';
+
 export interface NavItem {
 	label: string;
 	href: string;
+	/** Optional icon rendered with the label (e.g. GitHub mark). */
+	icon?: NavIconName;
 }
 
 /** Fully-resolved site configuration (after defaults are applied). */
@@ -52,6 +57,11 @@ export interface SiteConfig {
 	 */
 	homePage: string | null;
 	nav: NavItem[];
+	/**
+	 * Footer link row. Defaults to RSS + Topics when omitted.
+	 * Pass an explicit list (including RSS/Topics if you still want them) to customize.
+	 */
+	footerLinks: NavItem[];
 	topics: Topic[];
 	newsletter: NewsletterConfig | null;
 }
@@ -71,10 +81,33 @@ export interface SiteConfigInput {
 	/** Static page slug to show at `/` (post index then lives at `/writing`). */
 	homePage?: string;
 	nav?: NavItem[];
+	/** Custom footer links; replaces the default RSS + Topics row when set. */
+	footerLinks?: NavItem[];
 	topics?: Topic[];
 	newsletter?: NewsletterConfig | null;
 }
 
+const defaultFooterLinks: NavItem[] = [
+	{ label: 'RSS', href: '/rss.xml' },
+	{ label: 'Topics', href: '/topics' }
+];
+
+function normalizeNavItems(items: NavItem[] | undefined): NavItem[] | null {
+	if (!items?.length) return null;
+	return items.map((item) => {
+		const label = (item.label ?? '').trim();
+		const href = (item.href ?? '').trim();
+		if (!label || !href) {
+			throw new Error('filepress.config: nav/footerLinks entries need non-empty label and href.');
+		}
+		const icon = item.icon;
+		if (icon != null && icon !== 'github') {
+			throw new Error(`filepress.config: unsupported icon "${String(icon)}" (supported: github).`);
+		}
+		return icon ? { label, href, icon } : { label, href };
+	});
+}
+
 /** Path to page 1 of the chronological post index. */
 export function postsIndexPath(site: Pick<SiteConfig, 'homePage'>): string {
 	return site.homePage ? '/writing' : '/';
@@ -131,7 +164,8 @@ export function defineFilepressConfig(input: SiteConfigInput): SiteConfig {
 				? Math.floor(input.postsPerPage as number)
 				: 10,
 		homePage,
-		nav: input.nav && input.nav.length ? input.nav : defaultNav,
+		nav: normalizeNavItems(input.nav) ?? defaultNav,
+		footerLinks: normalizeNavItems(input.footerLinks) ?? [...defaultFooterLinks],
 		topics: input.topics ?? [],
 		newsletter: input.newsletter ?? null
 	};

package/packages/core/src/lib/index.ts

@@ -19,7 +19,8 @@ export type {
 	SiteConfigInput,
 	NewsletterConfig,
 	Topic,
-	NavItem
+	NavItem,
+	NavIconName
 } from './config';
 
 export { formatDate } from './format';

package/packages/core/src/lib/styles/theme.css

@@ -177,6 +177,24 @@ body {
 	color: var(--accent);
 }
 
+.site-nav a.has-icon,
+.site-footer a.has-icon {
+	display: inline-flex;
+	align-items: center;
+	gap: 0.4em;
+}
+
+.site-nav .nav-icon,
+.site-footer .nav-icon {
+	display: block;
+	flex-shrink: 0;
+}
+
+.site-nav a.nav-github {
+	text-transform: none;
+	letter-spacing: 0.06em;
+}
+
 .site-footer {
 	border-top: 1px solid var(--rule);
 	margin-top: clamp(2.5rem, 6vw, 4rem);
@@ -195,6 +213,7 @@ body {
 
 .site-footer .footer-links {
 	display: flex;
+	align-items: center;
 	gap: 1.1rem;
 }
 

package/packages/import/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@filepress/import",
-	"version": "0.1.0",
+	"version": "0.1.2",
 	"private": true,
 	"type": "module",
 	"description": "Crawl an existing site and scaffold a filepress content-only sibling (optional Ollama restyle).",

package/scripts/create-site.mjs

@@ -152,8 +152,8 @@ if (external) {
 				devDependencies: {
 					// link: uses the live engine tree (with its workspace node_modules).
 					// Alternatives after publish / push:
-					// "getfilepress": "^0.1.0"
-					// "getfilepress": "github:Catalyst-Forge-LLC/filepress#v0.1.0"
+					// "getfilepress": "^0.1.1"
+					// "getfilepress": "github:Catalyst-Forge-LLC/filepress#v0.1.1"
 					getfilepress: `link:${relToEngine}`
 				}
 			},
@@ -203,13 +203,13 @@ override the default Essay theme.
 \`link:\` only works on your machine. For CI/hosting, switch to npm or a git pin:
 
 \`\`\`json
-"getfilepress": "^0.1.0"
+"getfilepress": "^0.1.1"
 \`\`\`
 
 or:
 
 \`\`\`json
-"getfilepress": "github:Catalyst-Forge-LLC/filepress#v0.1.0"
+"getfilepress": "github:Catalyst-Forge-LLC/filepress#v0.1.1"
 \`\`\`
 
 | Setting | Value |