@jxpeng98/vitepress-published-pages

Frontmatter-driven published-page whitelist for VitePress.

What It Does

• Reads a frontmatter field such as published: true
• Excludes unpublished pages from srcExclude during build
• Filters nav and sidebar links that point at unpublished pages
• Renders unpublished pages as 404 in published-only mode, even on direct URL access
• Restarts the dev server when published or exclude changes, so navigation stays in sync
• Disables sitemap output when a published-only build has no published pages

Usage

import { withPublishedPages } from '@jxpeng98/vitepress-published-pages/plugin'
import { withSidebar } from 'vitepress-sidebar'

export default ({ command }) =>
  withPublishedPages(
    withSidebar(vitePressOptions, vitePressSidebarOptions),
    {
      command,
      scanRoots: ['en', 'zh'],
      includeTopLevelMarkdown: true,
    }
  )

Page frontmatter:

---
title: Public page
published: true
---

Options

• command: current VitePress command, usually serve or build
• rootDir: project root, defaults to process.cwd()
• scanRoots: directories to scan for markdown pages, defaults to ['.']
• includeTopLevelMarkdown: whether root-level *.md files should be scanned
• publishedFieldName: frontmatter field used for whitelist, defaults to published
• sidebarExcludeFieldName: optional sidebar-only exclusion field, defaults to exclude
• publishedOnlyEnvVar: env override, defaults to VITEPRESS_PUBLISHED_ONLY
• defaultPublishedOnly: override the default build => true, serve => false behavior
• disableSitemapWhenEmpty: defaults to true