blog software from scratch with SvelteKit
12 modules ยท 35 declarations
{ get: (error_message?: string | undefined) => { id: string; title: string; home_page_url: string; description: string; icon: string; favicon: string; author: { name: string; url?: string | undefined; email?: string | undefined; }; items: { ...; }[]; atom: { ...; }; }; get_maybe: () => { ...; } | undefined; set: (va... import {blog_feed_context} from '@fuzdev/fuz_blog/blog.js'; BlogConfig import type {BlogConfig} from '@fuzdev/fuz_blog/blog.js'; A single blog's configuration in the consumer's src/routes/blogs.ts registry.
dirnameRoute directory under src/routes, and the blog's base path segment -
so it equals the URL path, with no route groups and no leading or
trailing slash. Post pathnames derive from it.
type string
feedFeed-level metadata. Post ids and urls derive from home_page_url,
so set it to the blog's index page.
type BlogFeedMetadata
slug_routes?Generate a slug redirect route for each post.
When false, post URLs are the integer id paths.
type boolean
truescaffold?Customizes the post file gro post scaffolds for this blog.
Defaults to scaffold_blog_post.
type (options: BlogPostScaffoldOptions): string
optionsstringvalue + type
{ id: string; title: string; home_page_url: string; description: string; icon: string; favicon: string; author: { name: string; url?: string | undefined; email?: string | undefined; }; items: { id: string; ... 8 more ...; blog_post_id: number; }[]; atom: { ...; }; } import {BlogFeed} from '@fuzdev/fuz_blog/blog.js'; idtype string
titletype string
home_page_urltype string
descriptiontype string
icontype string
favicontype string
authortype { name: string; url?: string | undefined; email?: string | undefined; }
itemstype BlogFeedItem[]
atomtype { feed_url: string; }
value + type
{ id: string; title: string; url: string; date_published: string; date_modified: string; summary: string; tags: string[]; slug: string; pathname: string; blog_post_id: number; } import {BlogFeedItem} from '@fuzdev/fuz_blog/blog.js'; A feed entry, derived from a BlogPostMetadata by resolve_blog_feed_item. Strict, so a leaked consumer field fails the generated feed's validation.
idtype string
titletype string
urltype string
date_publishedtype string
date_modifiedtype string
summarytype string
tagstype string[]
slugtype string
pathnametype string
blog_post_idtype number
value + type
{ id: string; title: string; home_page_url: string; description: string; icon: string; favicon: string; author: { name: string; url?: string | undefined; email?: string | undefined; }; atom: { feed_url: string; }; } import {BlogFeedMetadata} from '@fuzdev/fuz_blog/blog.js'; A feed's metadata, without its items.
idtype string
titletype string
home_page_urltype string
descriptiontype string
icontype string
favicontype string
authortype { name: string; url?: string | undefined; email?: string | undefined; }
atomtype { feed_url: string; }
accepts children
import BlogPost from '@fuzdev/fuz_blog/BlogPost.svelte'; postitem?The resolved feed item. Defaults to looking post.slug up in
blog_feed_context; pass it explicitly to skip the context.
attrs?HTMLAttributes<HTMLElement>meta?Renders after BlogPostHeader, e.g. for post provenance.
Snippet<[item: BlogFeedItem]>item BlogFeedItemfooter?Snippet<[]>comments?Renders after footer, for a post's comments.
Snippet<[item: BlogFeedItem]>item BlogFeedItemchildrenSnippet<[]>BlogPostHeader.svelte view source
import BlogPostHeader from '@fuzdev/fuz_blog/BlogPostHeader.svelte'; itemBlogPostId type number & Flavor<"BlogPostId">
import type {BlogPostId} from '@fuzdev/fuz_blog/blog.js'; Flavored<number, 'BlogPostId'>BlogPostList.svelte view source
import BlogPostList from '@fuzdev/fuz_blog/BlogPostList.svelte'; feedvalue + type
{ title: string; date_published: string; date_modified: string; summary: string; slug: string; tags?: string[] | undefined; } & Record<string, unknown> type { title: string; date_published: string; date_modified: string; summary: string; slug: string; tags?: string[] | undefined; } & Record<string, unknown>
import {BlogPostMetadata} from '@fuzdev/fuz_blog/blog.js'; The author-defined metadata for each post. Loose so a consumer can add its own
fields (e.g. an autoblog's model); the extras stay on the page's post and
do not reach the generated BlogFeed (see resolve_blog_feed_item).
titletype string
date_publishedtype string
date_modifiedtype string
summarytype string
slugtype string
tags?type string[]
[key: string]type unknown
BlogPostModule import type {BlogPostModule} from '@fuzdev/fuz_blog/blog.js'; posttype BlogPostMetadata
defaulttype Component<any, {}, string>
BlogPostScaffoldOptions import type {BlogPostScaffoldOptions} from '@fuzdev/fuz_blog/blog.js'; The options gro post passes to a BlogConfig scaffold.
titletype string
slugtype string
dateUsed for both date_published and date_modified.
type string
fuz_blog_import_pathImport specifier for fuz_blog modules -
#lib inside fuz_blog itself, @fuzdev/fuz_blog in consumers.
type string
BlogsModule import type {BlogsModule} from '@fuzdev/fuz_blog/blog.js'; The shape of the consumer's src/routes/blogs.ts module.
blogstype BlogConfig[]
(blog_dir: string): BlogPostId[] import {collect_blog_post_ids} from '@fuzdev/fuz_blog/blog_helpers.js'; Returns an array of all of the sequential blog post ids starting with 1. When it fails to find the next id, the sequence ends.
blog_dirstring(data: { id: string; title: string; home_page_url: string; description: string; icon: string; favicon: string; author: { name: string; url?: string | undefined; email?: string | undefined; }; items: { ...; }[]; atom: { ...; }; }): string import {create_atom_feed} from '@fuzdev/fuz_blog/feed.js'; datastring (options: CreateBlogPostOptions): Promise<CreatedBlogPost> import {create_blog_post} from '@fuzdev/fuz_blog/blog_helpers.js'; Scaffolds and writes the next post file for config, returning its id, path,
and slug. Does not run gen - callers invoke that afterward (see post.task.ts).
optionsPromise<CreatedBlogPost>
CreateBlogPostOptions import type {CreateBlogPostOptions} from '@fuzdev/fuz_blog/blog_helpers.js'; dirThe project root, usually process.cwd().
type string
configThe target blog, e.g. from resolve_blog_config.
type BlogConfig
titleThe post title; the slug is derived from it.
type string
dateISO date used for both date_published and date_modified.
type string
fuz_blog_import_pathImport specifier for fuz_blog modules - #lib inside fuz_blog, @fuzdev/fuz_blog in consumers.
type string
scaffold?Overrides the scaffold for this call, taking precedence over
config.scaffold. Lets a consumer task close over its own args
(e.g. a --model flag) without widening BlogPostScaffoldOptions.
type (options: BlogPostScaffoldOptions): string
optionsstringroutes_path?type string
'src/routes'CreatedBlogPost import type {CreatedBlogPost} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_post_idtype BlogPostId
pathAbsolute path to the written +page.svelte.
type string
slugtype string
value + type
{ id: string; title: string; home_page_url: string; description: string; icon: string; favicon: string; author: { name: string; url?: string | undefined; email?: string | undefined; }; items: { id: string; ... 5 more ...; tags?: string[] | undefined; }[]; atom: { ...; }; } import {Feed} from '@fuzdev/fuz_blog/feed.js'; This is designed to extend JSON Feed 1.1 with namespaced data for other specs like Atom. It's still a work in progress, and I'll add features as I need them, and eventually this will be extracted to a standalone library. https://www.jsonfeed.org/version/1.1/
idtype string
titletype string
home_page_urltype string
descriptiontype string
icontype string
favicontype string
authortype { name: string; url?: string | undefined; email?: string | undefined; }
itemstype FeedItem[]
atomtype { feed_url: string; }
value + type
string import {FeedDatetime} from '@fuzdev/fuz_blog/feed.js'; An ISO 8601 UTC datetime string like 2024-07-15T00:00:00.000Z, the form
Date.prototype.toISOString writes. The date must exist on the calendar,
seconds are required, fractional seconds take any number of digits, and the
offset must be Z. The output is the input unchanged.
value + type
{ id: string; title: string; url: string; date_published: string; date_modified: string; summary: string; tags?: string[] | undefined; } import {FeedItem} from '@fuzdev/fuz_blog/feed.js'; idtype string
titletype string
urltype string
date_publishedtype string
date_modifiedtype string
summarytype string
tags?type string[]
FeedItemDate.svelte view source
import FeedItemDate from '@fuzdev/fuz_blog/FeedItemDate.svelte'; itemPipeSchema<string, PipeSchema<string, Schema<string, string, "string", undefined>>> type PipeSchema<string, PipeSchema<string, Schema<string, string, "string", undefined>>>
import {FeedUrl} from '@fuzdev/fuz_blog/feed.js'; An absolute URL as fuz_util's Url takes it, with no surrounding
whitespace: the text is kept as written, so padding would reach the
generated feed, where it fails here instead.
(date: string | number | Date): string import {format_date} from '@fuzdev/fuz_blog/util.js'; datestring | number | Datestring accepts children
import HashLink from '@fuzdev/fuz_blog/HashLink.svelte'; slugstringchildrenSnippet<[]>(blog_dir: string, blog_post_ids: BlogPostId[]): Promise<BlogPostModule[]> import {load_blog_post_modules} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_dirstringblog_post_idsBlogPostId[]Promise<BlogPostModule[]>
(dir: string): Promise<BlogsModule> import {load_blogs_module} from '@fuzdev/fuz_blog/blog_helpers.js'; Loads the consumer's src/routes/blogs.ts registry.
dirstringPromise<BlogsModule>
(blogs: BlogConfig[], dirname: string | undefined): BlogConfig import {resolve_blog_config} from '@fuzdev/fuz_blog/blog.js'; Resolves a BlogConfig from the registry by its dirname,
defaulting to the first registered blog when dirname is omitted.
Throws when dirname matches no registered blog.
blogsBlogConfig[]dirnamestring | undefinedBlogConfig (blog_post_id: BlogPostId, dirname: string, home_page_url: string, post: { title: string; date_published: string; date_modified: string; summary: string; slug: string; tags?: string[] | undefined; } & Record<...>, options?: { ...; } | undefined): { ...; } import {resolve_blog_feed_item} from '@fuzdev/fuz_blog/blog.js'; Derives a BlogFeedItem (the feed entry) from a post and its blog's
dirname and home_page_url. Emits only BlogFeedItem fields - a
consumer's extra post metadata stays on the page's post for its component
to render, and does not leak into the typed generated feed.
blog_post_idthe post's incrementing 1-based id
dirnamethe blog's route directory under src/routes, from its BlogConfig
stringhome_page_urlthe blog's index url, from its feed.home_page_url
stringpostthe author-defined post metadata
options?slug_routes: false makes url the integer-id id
{ slug_routes?: boolean | undefined; }(options: BlogPostScaffoldOptions): string import {scaffold_blog_post} from '@fuzdev/fuz_blog/blog_helpers.js'; The default post scaffold for gro post.
Override per-blog with BlogConfig.scaffold.
optionsstring (blog_dir: string, blog_post_id: BlogPostId): string import {to_blog_post_path} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_dirstringblog_post_idstring (blog_post_ids: BlogPostId[]): BlogPostId import {to_next_blog_post_id} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_post_idsBlogPostId[](options: UpdateBlogPostOptions): Promise<UpdatedBlogPost> import {update_blog_post} from '@fuzdev/fuz_blog/blog_helpers.js'; Rewrites the date_modified of an existing post file for config, returning
its id and path. Does not run gen - callers invoke that afterward (see
update_post.task.ts).
optionsPromise<UpdatedBlogPost>
UpdateBlogPostOptions import type {UpdateBlogPostOptions} from '@fuzdev/fuz_blog/blog_helpers.js'; dirThe project root, usually process.cwd().
type string
configThe target blog, e.g. from resolve_blog_config.
type BlogConfig
blog_post_idThe id of the post to update.
type BlogPostId
dateISO date written to date_modified.
type string
routes_path?type string
'src/routes'UpdatedBlogPost import type {UpdatedBlogPost} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_post_idtype BlogPostId
pathAbsolute path to the updated +page.svelte.
type string