Slug and Frontmatter Updates #3

Overview#

This PR fixes issues raised in #3

UX Changes#

Subdirectory support: Posts in nested folders like a/b/post.md can now preserve their full path in URLs (set slugSource: "path")
Frontmatter slug support: Use a field from your frontmatter (like slug or url) to define the path (set slugSource: "frontmatter")
Hugo index.md support: Remove /index suffix from paths automatically (set removeIndexFromSlug: true)
Custom text content: Use a frontmatter field like summary for the AT Protocol textContent instead of the full markdown body (set textContentField: "summary")
Description now works: The description field from frontmatter is now actually published to AT Protocol records (was a bug , never added to records before)

Example config using frontmatter slugs:

  {
    "siteUrl": "https://example.com",
    "contentDir": "content/posts",
    "pathPrefix": "/blog",
    "publicationUri": "at://did:plc:.../site.standard.publication/...",
    "slugSource": "frontmatter",
    "slugField": "url"
  }

Example frontmatter:

---
title: "My Post Title"
date: 2024-01-15
url: "2024/my-custom-slug"
summary: "A brief description of this post"
---

This would create a document with path /blog/2024/my-custom-slug

File Updates#

src/lib/types.ts

Added new config options to PublisherConfig:
slugSource: "filename" | "path" | "frontmatter" (default: "filename")
slugField: string for frontmatter field when using slugSource: "frontmatter"
removeIndexFromSlug: boolean to strip /index or /_index suffixes
textContentField: frontmatter field to use for textContent instead of markdown body
Added rawFrontmatter: Record<string, unknown> to BlogPost

src/lib/markdown.ts

Updated parseFrontmatter() to return rawFrontmatter
Added getSlugFromOptions() function supporting three modes (filename, path, frontmatter)
Added ScanOptions interface for cleaner option passing
Updated scanContentDirectory() to accept new slug options and pass rawFrontmatter

src/lib/atproto.ts

Added description field to DocumentRecord interface
Fixed createDocument() to add description to record when available
Fixed updateDocument() to add description to record when available
Added textContentField support to both functions

src/commands/publish.ts

Updated to pass new config options to scanContentDirectory()

src/commands/sync.ts

Updated to pass new config options to scanContentDirectory()
Fixed path matching to use configured pathPrefix

src/lib/config.ts

Updated generateConfigTemplate() to include new options

+2 -3

7 changed files

Interdiff #1 → #2

expand all

unified split

packages

cli

src

commands

inject.ts

publish.ts

sync.ts

lib

atproto.ts

config.ts

markdown.ts

types.ts

+2 -3

packages/cli/src/commands/inject.ts

··· 7 7 8 8 export const injectCommand = command({ 9 9 name: "inject", 10 - description: 11 - "Inject site.standard.document link tags into built HTML files", 10 + description: "Inject site.standard.document link tags into built HTML files", 12 11 args: { 13 12 outputDir: option({ 14 13 long: "output", ··· 53 52 slugToAtUri.set(postState.slug, postState.atUri); 54 53 55 54 // Also add the last segment for simpler matching 56 - // e.g., "40th-puzzle-box/what-a-gift" -> also map "what-a-gift" 55 + // e.g., "other/my-other-post" -> also map "my-other-post" 57 56 const lastSegment = postState.slug.split("/").pop(); 58 57 if (lastSegment && lastSegment !== postState.slug) { 59 58 slugToAtUri.set(lastSegment, postState.atUri);

packages/cli/src/commands/publish.ts