{ get: (error_message?: string | undefined) => BlogFeed; get_maybe: () => BlogFeed | undefined; set: (value: BlogFeed) => BlogFeed; } import {blog_feed_context} from '@fuzdev/fuz_blog/blog.js'; api #
blog software from scratch with SvelteKit
11 modules ยท 24 declarations
Modules #
blog_feed_context #
blog_feed_context
BlogComments #
BlogComments
MastodonBlogComments import type {BlogComments} from '@fuzdev/fuz_blog/blog.js'; url
type string
type
type "mastodon"
BlogFeed #
BlogFeed
BlogFeed import type {BlogFeed} from '@fuzdev/fuz_blog/blog.js'; inheritance
extends: Feed
items
type Array<BlogPostItem>
BlogFeedData #
BlogFeedData
BlogFeedData import type {BlogFeedData} from '@fuzdev/fuz_blog/blog.js'; id
type string
title
type string
home_page_url
type string
description
type string
icon
type string
favicon
type string
author
type { name: string; url?: string | undefined; email?: string | undefined; }
atom
type { feed_url: string; }
BlogModule #
BlogModule
BlogModule import type {BlogModule} from '@fuzdev/fuz_blog/blog.js'; blog
type BlogFeedData
BlogPost #
BlogPost
accepts children
import BlogPost from '@fuzdev/fuz_blog/BlogPost.svelte'; post
type BlogPostData
attrs?
type
HTMLAttributes<HTMLElement>optional
footer?
type
Snippet<[]>optional
separator?
type
Snippet<[]>optional default
default_separatorchildren
type
Snippet<[]>BlogPostData #
BlogPostData
BlogPostData import type {BlogPostData} from '@fuzdev/fuz_blog/blog.js'; The author-defined data for each post.
title
type string
slug
type string
date_published
type string
date_modified
type string
summary
type string
tags?
type Array<string>
comments?
type BlogComments
BlogPostHeader #
BlogPostHeader
BlogPostHeader.svelte view source
import BlogPostHeader from '@fuzdev/fuz_blog/BlogPostHeader.svelte'; item
type BlogPostItem
BlogPostId #
BlogPostId
BlogPostId import type {BlogPostId} from '@fuzdev/fuz_blog/blog.js'; intersects
Flavored<number, 'BlogPostId'>BlogPostItem #
BlogPostItem
BlogPostItem import type {BlogPostItem} from '@fuzdev/fuz_blog/blog.js'; inheritance
extends: BlogPostData
id
Blog post path with blog_post_id.
type string
url
Blog post path with slug.
type string
blog_post_id
Incrementing 1-based integer.
type BlogPostId
tags
type Array<string>
BlogPostModule #
BlogPostModule
BlogPostModule import type {BlogPostModule} from '@fuzdev/fuz_blog/blog.js'; post
type BlogPostData
default
type Component<any>
collect_blog_post_ids #
collect_blog_post_ids
(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_dir
type
stringreturns
BlogPostId[] create_atom_feed #
create_atom_feed
(data: Feed): string import {create_atom_feed} from '@fuzdev/fuz_blog/feed.js'; data
type Feed
returns
string Feed #
Feed
Feed import type {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/
id
type string
title
type string
home_page_url
type string
description
type string
icon
type string
favicon
type string
author
type {
name: string;
url?: string;
email?: string;
}
items
type Array<FeedItem>
atom
type {
feed_url: string;
}
FeedItem #
FeedItem
FeedItem import type {FeedItem} from '@fuzdev/fuz_blog/feed.js'; id
type string
title
type string
url
type string
date_published
type string
date_modified
type string
summary
type string
tags?
type Array<string>
FeedItemDate #
FeedItemDate
FeedItemDate.svelte view source
import FeedItemDate from '@fuzdev/fuz_blog/FeedItemDate.svelte'; item
type FeedItem
format_date #
format_date
(date: string | number | Date): string import {format_date} from '@fuzdev/fuz_blog/util.js'; date
type
string | number | Datereturns
string HashLink #
HashLink
accepts children
import HashLink from '@fuzdev/fuz_blog/HashLink.svelte'; slug
type
stringchildren
type
Snippet<[]>load_blog_post_modules #
load_blog_post_modules
(blog_dir: string, blog_post_ids: BlogPostId[]): Promise<BlogPostModule[]> import {load_blog_post_modules} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_dir
type
stringblog_post_ids
type
BlogPostId[]returns
Promise<BlogPostModule[]> MastodonBlogComments #
MastodonBlogComments
MastodonBlogComments import type {MastodonBlogComments} from '@fuzdev/fuz_blog/blog.js'; url
type string
type
type 'mastodon'
resolve_blog_post_item #
resolve_blog_post_item
(blog_post_id: BlogPostId, blog_url: string, post: BlogPostData): BlogPostItem import {resolve_blog_post_item} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_post_id
type BlogPostId
blog_url
type
stringpost
type BlogPostData
returns
BlogPostItem to_blog_post_path #
to_blog_post_path
(blog_dir: string, blog_post_id: BlogPostId): string import {to_blog_post_path} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_dir
type
stringblog_post_id
type BlogPostId
returns
string to_next_blog_post_id #
to_next_blog_post_id
(blog_post_ids: BlogPostId[]): BlogPostId import {to_next_blog_post_id} from '@fuzdev/fuz_blog/blog_helpers.js'; blog_post_ids
type
BlogPostId[]returns
BlogPostId to_pathname #
to_pathname
(url: string, root: string): string import {to_pathname} from '@fuzdev/fuz_blog/util.js'; url
type
stringroot
type
stringreturns
string