@binarynoir/vitepress-blog 0.1.1 → 0.3.0

package/dist/{plugin-BjbV6nDK.d.cts → plugin-Bb4rRwO8.d.cts}

@@ -16,8 +16,21 @@ interface BlogOptions {
     siteUrl?: string;
     /** Locale for dates in bylines and cards. Default: `'en-US'`. */
     locale?: string;
-    /** How dates are written. Default: `{ dateStyle: 'long' }`, in UTC. */
+    /** How dates are written. Default: `{ dateStyle: 'long' }`. */
     dateFormat?: Intl.DateTimeFormatOptions;
+    /**
+     * How times are written, for dates whose frontmatter gives one
+     * (`2026-10-20 14:30`). Default: `{ hour: 'numeric', minute: '2-digit', timeZoneName: 'short' }`,
+     * as in "2:30 PM EDT".
+     */
+    timeFormat?: Intl.DateTimeFormatOptions;
+    /**
+     * The time zone frontmatter times without an offset are in, and that every
+     * date and time is shown in: an IANA name such as `'America/New_York'`.
+     * A value with an offset (`2026-10-20T14:30:00-04:00`, `…Z`) is read as
+     * written. Default: `'UTC'`.
+     */
+    timeZone?: string;
     /** Reading speed for the "5 min read" estimate. `0` hides it. Default: `200`. */
     wordsPerMinute?: number;
     /** Add an author, date and tags line under each post's title. Default: `true`. */
@@ -68,8 +81,12 @@ interface BlogOptions {
 interface BlogLabels {
     /** Before the author names: "By Jane Doe". */
     by: string;
+    /** Before a post's `date` in its byline: "Published October 20, 2026". */
+    published: string;
     /** Before a post's `updated` date. */
     updated: string;
+    /** A date and its time: "{date} at {time}". */
+    dateTime: string;
     /** Reading time: "{n} min read". */
     readingTime: string;
     newer: string;
@@ -79,6 +96,16 @@ interface BlogLabels {
     draft: string;
     /** Badge on a sticky post. */
     sticky: string;
+    /** Badge on an announcement, and the accessible name of the announcement banner. */
+    announcement: string;
+    /** Above a blog page filtered to announcements (`?announcements`). */
+    announcements: string;
+    /** When the blog page has no announcements to show. */
+    noAnnouncements: 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. */
     undated: string;
@@ -138,8 +165,14 @@ interface BlogIndexConfig {
 interface BlogPostData {
     title: string;
     summary: string;
+    /** When the post was published, from `date`. */
     date: Date | null;
+    /** Whether `date` gave a time, not just a day. */
+    dateHasTime: boolean;
+    /** When the post was last changed, from `updated`. */
     updated: Date | null;
+    /** Whether `updated` gave a time, not just a day. */
+    updatedHasTime: boolean;
     /** As written: a path relative to the post, a public path (`/x.png`) or a URL. */
     image: string;
     imageAlt: string;
@@ -153,12 +186,32 @@ interface BlogPostData {
     scope: BlogScope;
     sticky: 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.
@@ -187,4 +240,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 BlogIndexConfig as d, type BlogLabels as e, type BlogLayout as f, type BlogOptions as g, type BlogPostData as h, type BlogScope as i, blogMarkdown as j };

package/dist/{plugin-BjbV6nDK.d.ts → plugin-Bb4rRwO8.d.ts}

@@ -16,8 +16,21 @@ interface BlogOptions {
     siteUrl?: string;
     /** Locale for dates in bylines and cards. Default: `'en-US'`. */
     locale?: string;
-    /** How dates are written. Default: `{ dateStyle: 'long' }`, in UTC. */
+    /** How dates are written. Default: `{ dateStyle: 'long' }`. */
     dateFormat?: Intl.DateTimeFormatOptions;
+    /**
+     * How times are written, for dates whose frontmatter gives one
+     * (`2026-10-20 14:30`). Default: `{ hour: 'numeric', minute: '2-digit', timeZoneName: 'short' }`,
+     * as in "2:30 PM EDT".
+     */
+    timeFormat?: Intl.DateTimeFormatOptions;
+    /**
+     * The time zone frontmatter times without an offset are in, and that every
+     * date and time is shown in: an IANA name such as `'America/New_York'`.
+     * A value with an offset (`2026-10-20T14:30:00-04:00`, `…Z`) is read as
+     * written. Default: `'UTC'`.
+     */
+    timeZone?: string;
     /** Reading speed for the "5 min read" estimate. `0` hides it. Default: `200`. */
     wordsPerMinute?: number;
     /** Add an author, date and tags line under each post's title. Default: `true`. */
@@ -68,8 +81,12 @@ interface BlogOptions {
 interface BlogLabels {
     /** Before the author names: "By Jane Doe". */
     by: string;
+    /** Before a post's `date` in its byline: "Published October 20, 2026". */
+    published: string;
     /** Before a post's `updated` date. */
     updated: string;
+    /** A date and its time: "{date} at {time}". */
+    dateTime: string;
     /** Reading time: "{n} min read". */
     readingTime: string;
     newer: string;
@@ -79,6 +96,16 @@ interface BlogLabels {
     draft: string;
     /** Badge on a sticky post. */
     sticky: string;
+    /** Badge on an announcement, and the accessible name of the announcement banner. */
+    announcement: string;
+    /** Above a blog page filtered to announcements (`?announcements`). */
+    announcements: string;
+    /** When the blog page has no announcements to show. */
+    noAnnouncements: 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. */
     undated: string;
@@ -138,8 +165,14 @@ interface BlogIndexConfig {
 interface BlogPostData {
     title: string;
     summary: string;
+    /** When the post was published, from `date`. */
     date: Date | null;
+    /** Whether `date` gave a time, not just a day. */
+    dateHasTime: boolean;
+    /** When the post was last changed, from `updated`. */
     updated: Date | null;
+    /** Whether `updated` gave a time, not just a day. */
+    updatedHasTime: boolean;
     /** As written: a path relative to the post, a public path (`/x.png`) or a URL. */
     image: string;
     imageAlt: string;
@@ -153,12 +186,32 @@ interface BlogPostData {
     scope: BlogScope;
     sticky: 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.
@@ -187,4 +240,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 BlogIndexConfig as d, type BlogLabels as e, type BlogLayout as f, type BlogOptions as g, type BlogPostData as h, type BlogScope as i, blogMarkdown as j };

package/dist/style.css

@@ -10,6 +10,9 @@
   --vp-blog-tag-bg: var(--vp-c-default-soft);
   --vp-blog-tag-color: var(--vp-c-text-2);
   --vp-blog-accent: var(--vp-c-brand-1);
+  --vp-blog-announcement-height: 40px;
+  --vp-blog-announcement-bg: var(--vp-button-brand-bg);
+  --vp-blog-announcement-color: var(--vp-button-brand-text);
 }
 
 /* Markdown inside the generated blocks is wrapped in <p>; its margins are handled here instead. */
@@ -201,6 +204,11 @@
   color: var(--vp-c-brand-1);
 }
 
+.vp-blog-badge--announcement {
+  background: var(--vp-c-tip-soft);
+  color: var(--vp-c-tip-1);
+}
+
 .vp-blog-badge--draft {
   background: var(--vp-c-warning-soft);
   color: var(--vp-c-warning-1);
@@ -416,3 +424,108 @@
   /* The RSS orange, as feed readers expect. */
   color: #f26522;
 }
+
+/*
+ * The announcement banner, in the theme's `layout-top` slot: fixed across the
+ * top of the window, one line high. While it shows, VitePress's
+ * --vp-layout-top-height moves the nav bar, sidebar and content down by its
+ * height. The class on <html> hides it before hydration once dismissed.
+ */
+:root:not(.vp-blog-announcement-dismissed):has(.vp-blog-announcement) {
+  --vp-layout-top-height: var(--vp-blog-announcement-height);
+}
+
+.vp-blog-announcement-dismissed .vp-blog-announcement {
+  display: none;
+}
+
+.vp-blog-announcement {
+  position: fixed;
+  top: 0;
+  right: 0;
+  left: 0;
+  z-index: var(--vp-z-index-layout-top);
+  display: flex;
+  gap: 8px;
+  align-items: center;
+  justify-content: center;
+  box-sizing: border-box;
+  height: var(--vp-blog-announcement-height);
+  padding: 0 48px;
+  background: var(--vp-blog-announcement-bg);
+  color: var(--vp-blog-announcement-color);
+  font-size: 14px;
+  font-weight: 500;
+  line-height: var(--vp-blog-announcement-height);
+}
+
+.vp-blog-announcement__content {
+  display: flex;
+  gap: 10px;
+  align-items: center;
+  min-width: 0;
+}
+
+.vp-blog-announcement__text {
+  overflow: hidden;
+  color: inherit;
+  text-decoration: none;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
+.vp-blog-announcement__text:hover {
+  text-decoration: underline;
+  text-underline-offset: 3px;
+}
+
+/* How many announcements there are: a counter pill that opens the list of them. */
+.vp-blog-announcement__count {
+  flex: none;
+  min-width: 22px;
+  padding: 0 7px;
+  border-radius: 999px;
+  background: var(--vp-blog-announcement-color);
+  color: var(--vp-blog-announcement-bg);
+  font-size: 12px;
+  font-weight: 700;
+  font-variant-numeric: tabular-nums;
+  line-height: 20px;
+  text-align: center;
+  text-decoration: none;
+  transition: opacity 0.25s;
+}
+
+a.vp-blog-announcement__count:hover {
+  opacity: 0.85;
+}
+
+.vp-blog-announcement__dismiss {
+  position: absolute;
+  top: 50%;
+  right: 12px;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  width: 28px;
+  height: 28px;
+  border-radius: 6px;
+  color: inherit;
+  opacity: 0.8;
+  transform: translateY(-50%);
+  transition:
+    background-color 0.25s,
+    opacity 0.25s;
+}
+
+.vp-blog-announcement__dismiss:hover {
+  background: rgba(255, 255, 255, 0.16);
+  opacity: 1;
+}
+
+@media (max-width: 639px) {
+  .vp-blog-announcement {
+    justify-content: flex-start;
+    padding: 0 48px 0 16px;
+  }
+}