@stacksjs/bunpress 0.0.5

package/dist/toc.d.ts

@@ -0,0 +1,65 @@
+import type { TocConfig, TocData, TocHeading, TocPositionData } from './types';
+/**
+ * Generate a URL-safe slug from heading text
+ */
+export declare function generateSlug(text: string): string;
+/**
+ * Generate unique slug for heading, handling duplicates
+ */
+export declare function generateUniqueSlug(text: string, existingSlugs: Set<string>): string;
+/**
+ * Extract headings from markdown content
+ */
+export declare function extractHeadings(content: string): TocHeading[];
+/**
+ * Build hierarchical TOC structure from flat headings
+ */
+export declare function buildTocHierarchy(headings: TocHeading[]): TocHeading[];
+/**
+ * Filter headings based on configuration
+ */
+export declare function filterHeadings(headings: TocHeading[], config: TocConfig): TocHeading[];
+/**
+ * Generate TOC HTML
+ */
+export declare function generateTocHtml(data: TocData): string;
+/**
+ * Generate inline TOC HTML (for [[toc]] syntax)
+ */
+export declare function generateInlineTocHtml(data: TocData): string;
+/**
+ * Generate sidebar TOC HTML
+ */
+export declare function generateSidebarTocHtml(data: TocData): string;
+/**
+ * Generate floating TOC HTML
+ */
+export declare function generateFloatingTocHtml(data: TocData): string;
+/**
+ * Generate TOC data from markdown content and configuration
+ */
+export declare function generateTocData(content: string, config?: Partial<TocConfig>): TocData;
+/**
+ * Generate TOC for specific positions
+ */
+export declare function generateTocPositions(content: string, config?: Partial<TocConfig>): TocPositionData[];
+/**
+ * Process [[toc]] inline syntax in markdown content
+ */
+export declare function processInlineTocSyntax(content: string, tocData: TocData): string;
+/**
+ * Generate heading anchors and enhance heading HTML
+ */
+export declare function enhanceHeadingsWithAnchors(content: string): string;
+/**
+ * Generate CSS for TOC styling and interactions
+ */
+export declare function generateTocStyles(): string;
+/**
+ * Generate JavaScript for TOC interactions
+ */
+export declare function generateTocScripts(): string;
+/**
+ * Default TOC configuration
+ */
+export declare const defaultTocConfig: Required<TocConfig>;

package/dist/types.d.ts

@@ -0,0 +1,241 @@
+import type { marked } from 'marked';
+export declare interface BunPressConfig {
+  verbose: boolean
+  markdown: MarkdownPluginConfig
+  nav?: NavItem[]
+  plugins?: ConfigPlugin[]
+  sitemap?: SitemapConfig
+  robots?: RobotsConfig
+}
+/**
+ * Configuration options for the markdown plugin
+ */
+export declare interface MarkdownPluginConfig {
+  template?: string
+  css?: string
+  scripts?: string[]
+  title?: string
+  meta?: Record<string, string>
+  markedOptions?: Parameters<typeof marked.parse>[1]
+  preserveDirectoryStructure?: boolean
+  toc?: TocConfig
+  sidebar?: Record<string, SidebarItem[]>
+  nav?: NavItem[]
+  search?: SearchConfig
+  themeConfig?: ThemeConfig
+  sitemap?: SitemapConfig
+  robots?: RobotsConfig
+}
+/**
+ * Sidebar navigation item
+ */
+export declare interface SidebarItem {
+  text: string
+  link?: string
+  items?: SidebarItem[]
+}
+/**
+ * Navigation bar item
+ */
+export declare interface NavItem {
+  text: string
+  link?: string
+  icon?: string
+  items?: NavItem[]
+  activeMatch?: string
+}
+/**
+ * Action link in hero section
+ */
+export declare interface HeroAction {
+  theme?: 'brand' | 'alt'
+  text: string
+  link: string
+}
+/**
+ * Hero section configuration
+ */
+export declare interface Hero {
+  name?: string
+  text: string
+  tagline?: string
+  image?: string
+  actions?: HeroAction[]
+}
+/**
+ * Feature item configuration
+ */
+export declare interface Feature {
+  title: string
+  icon?: string
+  details: string
+}
+/**
+ * Frontmatter structure extracted from markdown files
+ */
+export declare interface Frontmatter {
+  title?: string
+  layout?: 'home' | 'doc' | 'page'
+  hero?: Hero
+  features?: Feature[]
+}
+/**
+ * Table of Contents configuration
+ */
+export declare interface TocConfig {
+  enabled?: boolean
+  position?: TocPosition | TocPosition[]
+  title?: string
+  maxDepth?: number
+  minDepth?: number
+  className?: string
+  smoothScroll?: boolean
+  activeHighlight?: boolean
+  collapsible?: boolean
+  exclude?: string[]
+}
+/**
+ * Search configuration
+ */
+export declare interface SearchConfig {
+  enabled?: boolean
+  placeholder?: string
+  maxResults?: number
+  keyboardShortcuts?: boolean
+  searchFn?: (query: string, content: string[]) => SearchResult[]
+}
+/**
+ * Search result item
+ */
+export declare interface SearchResult {
+  title: string
+  url: string
+  content: string
+  score: number
+}
+/**
+ * Theme configuration
+ */
+export declare interface ThemeConfig {
+  colors?: {
+    primary?: string
+    secondary?: string
+    accent?: string
+    background?: string
+    surface?: string
+    text?: string
+    muted?: string
+  }
+  fonts?: {
+    heading?: string
+    body?: string
+    mono?: string
+  }
+  darkMode?: boolean | 'auto'
+  cssVars?: Record<string, string>
+  css?: string
+}
+/**
+ * Configuration plugin interface
+ */
+export declare interface ConfigPlugin {
+  name: string
+  extendConfig?: (config: BunPressConfig) => BunPressConfig
+  validateConfig?: (config: BunPressConfig) => ConfigValidationResult
+  onConfigLoad?: (config: BunPressConfig) => void | Promise<void>
+  onConfigChange?: (newConfig: BunPressConfig, oldConfig: BunPressConfig) => void | Promise<void>
+}
+/**
+ * Configuration validation result
+ */
+export declare interface ConfigValidationResult {
+  valid: boolean
+  errors: string[]
+  warnings: string[]
+}
+/**
+ * Heading item in TOC
+ */
+export declare interface TocHeading {
+  level: number
+  text: string
+  id: string
+  children: TocHeading[]
+  exclude?: boolean
+  hasCode?: boolean
+}
+/**
+ * Table of Contents data structure
+ */
+export declare interface TocData {
+  title: string
+  items: TocHeading[]
+  config: TocConfig
+}
+/**
+ * TOC position data
+ */
+export declare interface TocPositionData {
+  position: TocPosition
+  data: TocData
+  html: string
+}
+/**
+ * Sitemap configuration
+ */
+export declare interface SitemapConfig {
+  enabled?: boolean
+  baseUrl?: string
+  filename?: string
+  defaultPriority?: number
+  defaultChangefreq?: SitemapChangefreq
+  priorityMap?: Record<string, number>
+  changefreqMap?: Record<string, SitemapChangefreq>
+  exclude?: string[]
+  maxUrlsPerFile?: number
+  useSitemapIndex?: boolean
+  transform?: (entry: SitemapEntry) => SitemapEntry | null
+  verbose?: boolean
+}
+/**
+ * Sitemap entry
+ */
+export declare interface SitemapEntry {
+  url: string
+  lastmod?: string | Date
+  changefreq?: SitemapChangefreq
+  priority?: number
+}
+/**
+ * Robots.txt configuration
+ */
+export declare interface RobotsConfig {
+  enabled?: boolean
+  filename?: string
+  rules?: RobotsRule[]
+  sitemaps?: string[]
+  host?: string
+  customContent?: string
+}
+/**
+ * Robots.txt rule
+ */
+export declare interface RobotsRule {
+  userAgent: string
+  allow?: string[]
+  disallow?: string[]
+  crawlDelay?: number
+}
+export type BunPressOptions = Partial<BunPressConfig>
+/**
+ * Plugin options for the Markdown plugin
+ */
+export type MarkdownPluginOptions = Partial<MarkdownPluginConfig>
+/**
+ * TOC position options
+ */
+export type TocPosition = 'sidebar' | 'inline' | 'floating'
+/**
+ * Sitemap change frequency values
+ */
+export type SitemapChangefreq = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never'

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@stacksjs/bunpress",
+  "type": "module",
+  "version": "0.0.5",
+  "description": "Modern documentation engine. Powered by Bun.",
+  "author": "Chris Breuer <chris@stacksjs.org>",
+  "license": "MIT",
+  "homepage": "https://github.com/stacksjs/bunpress#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stacksjs/bunpress.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stacksjs/bunpress/issues"
+  },
+  "keywords": [
+    "bunpress",
+    "bun",
+    "cli",
+    "typescript",
+    "vitepress alternative"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/src/index.js"
+    },
+    "./*": {
+      "import": "./dist/*"
+    }
+  },
+  "module": "./dist/src/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "bunpress": "./dist/bin/cli.js"
+  },
+  "files": [
+    "README.md",
+    "dist"
+  ],
+  "scripts": {
+    "dev": "bun run dev:docs",
+    "build": "bun --bun build.ts && bun run compile",
+    "compile": "bun build ./bin/cli.ts --compile --minify --outfile bin/bunpress",
+    "compile:all": "bun run compile:linux-x64 && bun run compile:linux-arm64 && bun run compile:windows-x64 && bun run compile:darwin-x64 && bun run compile:darwin-arm64",
+    "compile:linux-x64": "bun build ./bin/cli.ts --compile --minify --target=bun-linux-x64 --outfile bin/bunpress-linux-x64",
+    "compile:linux-arm64": "bun build ./bin/cli.ts --compile --minify --target=bun-linux-arm64 --outfile bin/bunpress-linux-arm64",
+    "compile:windows-x64": "bun build ./bin/cli.ts --compile --minify --target=bun-windows-x64 --outfile bin/bunpress-windows-x64.exe",
+    "compile:darwin-x64": "bun build ./bin/cli.ts --compile --minify --target=bun-darwin-x64 --outfile bin/bunpress-darwin-x64",
+    "compile:darwin-arm64": "bun build ./bin/cli.ts --compile --minify --target=bun-darwin-arm64 --outfile bin/bunpress-darwin-arm64",
+    "fresh": "bunx rimraf node_modules/ bun.lock && bun i",
+    "prepublishOnly": "bun --bun run build && bun run compile:all",
+    "test": "bun test --reporter=verbose",
+    "test:quick": "bun test --timeout=10000",
+    "test:full": "bun test --timeout=60000 --no-bail",
+    "lint": "bunx --bun eslint .",
+    "lint:fix": "bunx --bun eslint . --fix",
+    "changelog": "bunx logsmith --verbose",
+    "changelog:generate": "bunx logsmith --output CHANGELOG.md",
+    "release": "bun run changelog:generate && bunx --bun bumpx prompt --recursive",
+    "dev:docs": "bun bin/cli.ts dev",
+    "build:docs": "bun build.ts",
+    "preview:docs": "bun serve --port 3000 dist",
+    "typecheck": "bun --bun tsc --noEmit"
+  },
+  "devDependencies": {
+    "@stacksjs/bumpx": "^0.1.84",
+    "@stacksjs/eslint-config": "^4.14.0-beta.3",
+    "@stacksjs/gitlint": "^0.1.5",
+    "@stacksjs/headwind": "^0.1.1",
+    "@stacksjs/logsmith": "^0.1.18",
+    "@stacksjs/ts-i18n": "^0.0.0",
+    "bun-git-hooks": "^0.3.1",
+    "bun-plugin-dtsx": "0.9.5",
+    "bunfig": "^0.15.0",
+    "typescript": "^5.9.3"
+  },
+  "git-hooks": {
+    "pre-commit": {
+      "staged-lint": {
+        "*.{js,ts,json,yaml,yml,md}": "bunx --bun eslint --fix"
+      }
+    },
+    "commit-msg": "bunx gitlint --edit .git/COMMIT_EDITMSG"
+  }
+}