@binarynoir/vitepress-blog 0.2.0 → 0.4.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export { B as BlogAuthor, a as BlogFeedConfig, b as BlogIndexConfig, c as BlogLabels, d as BlogLayout, e as BlogOptions, f as BlogPostData, g as BlogScope, D as DEFAULT_LABELS, h as blogMarkdown } from './plugin-BlfpqyX4.cjs';
+export { B as BlogAnnouncementData, a as BlogAnnouncementItem, b as BlogAuthor, c as BlogFeedConfig, d as BlogGroupBy, e as BlogIndexConfig, f as BlogLabels, g as BlogLayout, h as BlogOptions, i as BlogPostData, j as BlogScope, D as DEFAULT_LABELS, k as blogMarkdown } from './plugin-DUTUA_t4.cjs';
 import 'markdown-it';
 
 /** Marker a blog page can use to say where its list of posts goes. Without it the list is appended. */

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { B as BlogAuthor, a as BlogFeedConfig, b as BlogIndexConfig, c as BlogLabels, d as BlogLayout, e as BlogOptions, f as BlogPostData, g as BlogScope, D as DEFAULT_LABELS, h as blogMarkdown } from './plugin-BlfpqyX4.js';
+export { B as BlogAnnouncementData, a as BlogAnnouncementItem, b as BlogAuthor, c as BlogFeedConfig, d as BlogGroupBy, e as BlogIndexConfig, f as BlogLabels, g as BlogLayout, h as BlogOptions, i as BlogPostData, j as BlogScope, D as DEFAULT_LABELS, k as blogMarkdown } from './plugin-DUTUA_t4.js';
 import 'markdown-it';
 
 /** Marker a blog page can use to say where its list of posts goes. Without it the list is appended. */

package/dist/index.js

@@ -5,7 +5,8 @@ import {
   POST_FRONTMATTER_KEY,
   WIDGET_NAME,
   blogMarkdown
-} from "./chunk-PWNWSYI4.js";
+} from "./chunk-ZM5FOUT4.js";
+import "./chunk-42Z6H7IN.js";
 export {
   BLOG_POSTS_PLACEHOLDER,
   DEFAULT_LABELS,

package/dist/{plugin-BlfpqyX4.d.cts → plugin-DUTUA_t4.d.cts}

@@ -64,10 +64,12 @@ interface BlogOptions {
      */
     pageSize?: number;
     /**
-     * Most sticky posts pinned to the top of a blog page, for those that don't
-     * set `stickyLimit`. Extra sticky posts take their place by date. `0` pins
-     * them all. Default: `0`.
+     * Most `pinned: true` posts kept at the top of a blog page, for those that
+     * don't set `pinLimit`. Extra pinned posts take their place by date. `0`
+     * pins them all. Default: `0`.
      */
+    pinLimit?: number;
+    /** @deprecated Renamed `pinLimit`; still read when `pinLimit` isn't set. */
     stickyLimit?: number;
     /**
      * Show a "Subscribe" RSS link on blog pages and `::: blog-posts` blocks,
@@ -75,7 +77,7 @@ interface BlogOptions {
      * on a site with a site URL (without one, no feeds are written). Default: `true`.
      */
     rssLink?: boolean;
-    /** Words the plugin writes on pages, for translating. `{n}`, `{blog}` and `{tag}` are filled in. */
+    /** Words the plugin writes on pages, for translating. `{n}`, `{blog}` and `{filter}` are filled in. */
     labels?: Partial<BlogLabels>;
 }
 interface BlogLabels {
@@ -94,19 +96,41 @@ interface BlogLabels {
     /** The link back to a post's blog: "All posts in {blog}". */
     allPosts: string;
     draft: string;
-    /** Badge on a sticky post. */
-    sticky: string;
+    /** Badge on a pinned post. */
+    pinned: string;
+    /** Badge on an announcement, and the accessible name of the announcement banner. */
+    announcement: string;
+    /** A blog page's announcements filter (`?announcements`), in the active filters. */
+    announcements: string;
+    /** Tooltip of the banner's count badge: "{n} announcements". */
+    announcementCount: string;
+    /** Accessible name of the banner's close button. */
+    dismiss: string;
     noPosts: string;
-    /** Year heading for posts without a date, when a blog groups by year. */
+    /** Group heading for posts without a date, when a blog groups by year or month. */
     undated: string;
-    /** Label of a blog page's keyword list. */
+    /** Accessible name of the browse panel above a blog page's posts. */
+    browse: string;
+    /** Label of the browse panel's category row. */
+    categories: string;
+    /** Label of the browse panel's keyword row. */
     tags: string;
-    /** Above a list filtered by keyword: "Posts tagged {tag}". */
-    tagged: string;
-    /** Link that clears the keyword filter. */
+    /** Label of the browse panel's year row. */
+    archive: string;
+    /** Names a category filter among the active filters: "Category". */
+    category: string;
+    /** Names a keyword filter among the active filters: "Keyword". */
+    tag: string;
+    /** How many posts the active filters match: "{n} posts". */
+    postCount: string;
+    /** The same, for one post: "{n} post". */
+    postCountOne: string;
+    /** When no post matches the active filters. */
+    noMatches: string;
+    /** Accessible name of an active filter's remove link: "Remove filter: {filter}". */
+    removeFilter: string;
+    /** Link that clears every filter. */
     showAll: string;
-    /** When no post has the keyword: "No posts tagged {tag}." */
-    noTagged: string;
     previous: string;
     next: string;
     /** Accessible name of the page links. */
@@ -119,6 +143,8 @@ interface BlogLabels {
 declare const DEFAULT_LABELS: BlogLabels;
 type BlogScope = 'site' | 'section';
 type BlogLayout = 'list' | 'grid' | 'compact';
+/** How a blog page groups its posts under headings: by year, by month, or not at all (`''`). */
+type BlogGroupBy = 'year' | 'month' | '';
 interface BlogFeedConfig {
     title?: string;
     description?: string;
@@ -134,19 +160,27 @@ interface BlogIndexConfig {
     folders: string[];
     /** Only list posts with at least one of these tags. */
     tags: string[];
+    /** Only list posts in one of these categories. */
+    categories: string[];
     /** Most posts to list. `0` lists them all. */
     limit: number;
     layout: BlogLayout;
-    /** Put a year heading above each year's posts. */
-    groupByYear: boolean;
+    /** Put a heading above each year's or month's posts. */
+    groupBy: BlogGroupBy;
     /** Show the post's tags on each card. */
     showTags: boolean;
+    /** Show the post's category above its title on each card. */
+    showCategory: boolean;
+    /** List every category above the posts, each one a filter. */
+    categoryList: boolean;
     /** List every keyword above the posts, each one a filter. */
     tagList: boolean;
+    /** List the years and months that have posts above the posts, each one a filter. */
+    archive: boolean;
     /** Posts per page. `0` shows them all on one page. */
     pageSize: number;
-    /** Most sticky posts pinned to the top. `0` pins them all. */
-    stickyLimit: number;
+    /** Most pinned posts kept at the top. `0` pins them all. */
+    pinLimit: number;
     /** Show a "Subscribe" link to the blog's feed. */
     rssLink: boolean;
     feed: BlogFeedConfig | null;
@@ -174,14 +208,34 @@ interface BlogPostData {
     tags: string[];
     category: string;
     scope: BlogScope;
-    sticky: boolean;
+    pinned: boolean;
     draft: boolean;
+    /** Shown in the announcement banner above the nav bar. */
+    announcement: boolean;
+    /** The banner's text, from `announcement: "…"`. `''` uses the title. */
+    announcementText: string;
     /** Per-post overrides of the `byline`, `cover` and `postNav` options. */
     byline?: boolean;
     cover?: boolean;
     postNav?: boolean;
     readingMinutes: number;
 }
+/** One announcement, as the banner shows it. */
+interface BlogAnnouncementItem {
+    /** The post's path and date: what a dismissal remembers, so re-dating a post announces it again. */
+    id: string;
+    text: string;
+    /** The post's URL path, without the site's base. */
+    link: string;
+}
+/** What the announcement banner reads from VitePress's site data. */
+interface BlogAnnouncementData {
+    /** Newest first: the banner shows the first one that hasn't been dismissed. */
+    items: BlogAnnouncementItem[];
+    /** The blog page filtered to announcements (`/blog/?announcements`), without the base, or `''` when no blog lists them. */
+    listLink: string;
+    labels: Pick<BlogLabels, 'announcement' | 'announcementCount' | 'dismiss'>;
+}
 
 /**
  * A markdown-it plugin that turns pages into a blog.
@@ -210,4 +264,4 @@ interface BlogPostData {
  */
 declare function blogMarkdown(md: MarkdownIt, options?: BlogOptions): void;
 
-export { type BlogAuthor as B, DEFAULT_LABELS as D, type BlogFeedConfig as a, type BlogIndexConfig as b, type BlogLabels as c, type BlogLayout as d, type BlogOptions as e, type BlogPostData as f, type BlogScope as g, blogMarkdown as h };
+export { type BlogAnnouncementData as B, DEFAULT_LABELS as D, type BlogAnnouncementItem as a, type BlogAuthor as b, type BlogFeedConfig as c, type BlogGroupBy as d, type BlogIndexConfig as e, type BlogLabels as f, type BlogLayout as g, type BlogOptions as h, type BlogPostData as i, type BlogScope as j, blogMarkdown as k };

package/dist/{plugin-BlfpqyX4.d.ts → plugin-DUTUA_t4.d.ts}

@@ -64,10 +64,12 @@ interface BlogOptions {
      */
     pageSize?: number;
     /**
-     * Most sticky posts pinned to the top of a blog page, for those that don't
-     * set `stickyLimit`. Extra sticky posts take their place by date. `0` pins
-     * them all. Default: `0`.
+     * Most `pinned: true` posts kept at the top of a blog page, for those that
+     * don't set `pinLimit`. Extra pinned posts take their place by date. `0`
+     * pins them all. Default: `0`.
      */
+    pinLimit?: number;
+    /** @deprecated Renamed `pinLimit`; still read when `pinLimit` isn't set. */
     stickyLimit?: number;
     /**
      * Show a "Subscribe" RSS link on blog pages and `::: blog-posts` blocks,
@@ -75,7 +77,7 @@ interface BlogOptions {
      * on a site with a site URL (without one, no feeds are written). Default: `true`.
      */
     rssLink?: boolean;
-    /** Words the plugin writes on pages, for translating. `{n}`, `{blog}` and `{tag}` are filled in. */
+    /** Words the plugin writes on pages, for translating. `{n}`, `{blog}` and `{filter}` are filled in. */
     labels?: Partial<BlogLabels>;
 }
 interface BlogLabels {
@@ -94,19 +96,41 @@ interface BlogLabels {
     /** The link back to a post's blog: "All posts in {blog}". */
     allPosts: string;
     draft: string;
-    /** Badge on a sticky post. */
-    sticky: string;
+    /** Badge on a pinned post. */
+    pinned: string;
+    /** Badge on an announcement, and the accessible name of the announcement banner. */
+    announcement: string;
+    /** A blog page's announcements filter (`?announcements`), in the active filters. */
+    announcements: string;
+    /** Tooltip of the banner's count badge: "{n} announcements". */
+    announcementCount: string;
+    /** Accessible name of the banner's close button. */
+    dismiss: string;
     noPosts: string;
-    /** Year heading for posts without a date, when a blog groups by year. */
+    /** Group heading for posts without a date, when a blog groups by year or month. */
     undated: string;
-    /** Label of a blog page's keyword list. */
+    /** Accessible name of the browse panel above a blog page's posts. */
+    browse: string;
+    /** Label of the browse panel's category row. */
+    categories: string;
+    /** Label of the browse panel's keyword row. */
     tags: string;
-    /** Above a list filtered by keyword: "Posts tagged {tag}". */
-    tagged: string;
-    /** Link that clears the keyword filter. */
+    /** Label of the browse panel's year row. */
+    archive: string;
+    /** Names a category filter among the active filters: "Category". */
+    category: string;
+    /** Names a keyword filter among the active filters: "Keyword". */
+    tag: string;
+    /** How many posts the active filters match: "{n} posts". */
+    postCount: string;
+    /** The same, for one post: "{n} post". */
+    postCountOne: string;
+    /** When no post matches the active filters. */
+    noMatches: string;
+    /** Accessible name of an active filter's remove link: "Remove filter: {filter}". */
+    removeFilter: string;
+    /** Link that clears every filter. */
     showAll: string;
-    /** When no post has the keyword: "No posts tagged {tag}." */
-    noTagged: string;
     previous: string;
     next: string;
     /** Accessible name of the page links. */
@@ -119,6 +143,8 @@ interface BlogLabels {
 declare const DEFAULT_LABELS: BlogLabels;
 type BlogScope = 'site' | 'section';
 type BlogLayout = 'list' | 'grid' | 'compact';
+/** How a blog page groups its posts under headings: by year, by month, or not at all (`''`). */
+type BlogGroupBy = 'year' | 'month' | '';
 interface BlogFeedConfig {
     title?: string;
     description?: string;
@@ -134,19 +160,27 @@ interface BlogIndexConfig {
     folders: string[];
     /** Only list posts with at least one of these tags. */
     tags: string[];
+    /** Only list posts in one of these categories. */
+    categories: string[];
     /** Most posts to list. `0` lists them all. */
     limit: number;
     layout: BlogLayout;
-    /** Put a year heading above each year's posts. */
-    groupByYear: boolean;
+    /** Put a heading above each year's or month's posts. */
+    groupBy: BlogGroupBy;
     /** Show the post's tags on each card. */
     showTags: boolean;
+    /** Show the post's category above its title on each card. */
+    showCategory: boolean;
+    /** List every category above the posts, each one a filter. */
+    categoryList: boolean;
     /** List every keyword above the posts, each one a filter. */
     tagList: boolean;
+    /** List the years and months that have posts above the posts, each one a filter. */
+    archive: boolean;
     /** Posts per page. `0` shows them all on one page. */
     pageSize: number;
-    /** Most sticky posts pinned to the top. `0` pins them all. */
-    stickyLimit: number;
+    /** Most pinned posts kept at the top. `0` pins them all. */
+    pinLimit: number;
     /** Show a "Subscribe" link to the blog's feed. */
     rssLink: boolean;
     feed: BlogFeedConfig | null;
@@ -174,14 +208,34 @@ interface BlogPostData {
     tags: string[];
     category: string;
     scope: BlogScope;
-    sticky: boolean;
+    pinned: boolean;
     draft: boolean;
+    /** Shown in the announcement banner above the nav bar. */
+    announcement: boolean;
+    /** The banner's text, from `announcement: "…"`. `''` uses the title. */
+    announcementText: string;
     /** Per-post overrides of the `byline`, `cover` and `postNav` options. */
     byline?: boolean;
     cover?: boolean;
     postNav?: boolean;
     readingMinutes: number;
 }
+/** One announcement, as the banner shows it. */
+interface BlogAnnouncementItem {
+    /** The post's path and date: what a dismissal remembers, so re-dating a post announces it again. */
+    id: string;
+    text: string;
+    /** The post's URL path, without the site's base. */
+    link: string;
+}
+/** What the announcement banner reads from VitePress's site data. */
+interface BlogAnnouncementData {
+    /** Newest first: the banner shows the first one that hasn't been dismissed. */
+    items: BlogAnnouncementItem[];
+    /** The blog page filtered to announcements (`/blog/?announcements`), without the base, or `''` when no blog lists them. */
+    listLink: string;
+    labels: Pick<BlogLabels, 'announcement' | 'announcementCount' | 'dismiss'>;
+}
 
 /**
  * A markdown-it plugin that turns pages into a blog.
@@ -210,4 +264,4 @@ interface BlogPostData {
  */
 declare function blogMarkdown(md: MarkdownIt, options?: BlogOptions): void;
 
-export { type BlogAuthor as B, DEFAULT_LABELS as D, type BlogFeedConfig as a, type BlogIndexConfig as b, type BlogLabels as c, type BlogLayout as d, type BlogOptions as e, type BlogPostData as f, type BlogScope as g, blogMarkdown as h };
+export { type BlogAnnouncementData as B, DEFAULT_LABELS as D, type BlogAnnouncementItem as a, type BlogAuthor as b, type BlogFeedConfig as c, type BlogGroupBy as d, type BlogIndexConfig as e, type BlogLabels as f, type BlogLayout as g, type BlogOptions as h, type BlogPostData as i, type BlogScope as j, blogMarkdown as k };