docmedown 0.1.0 → 0.1.1

package/dist/types/runtime/types.d.ts

@@ -1,103 +1,29 @@
-/**
- * DocMeDown Configuration and Runtime Type Definitions
- */
-export type ThemePreset = 'indigo' | 'emerald' | 'sunset' | 'violet' | 'rose' | 'slate' | 'cyberpunk';
-export type ColorMode = 'light' | 'dark' | 'auto';
-export interface NavLink {
-    label: string;
-    href: string;
-    external?: boolean;
-    icon?: string;
-}
-export interface SocialLink {
-    type: 'github' | 'gitlab' | 'twitter' | 'x' | 'discord' | 'custom';
-    url: string;
-    label?: string;
-    icon?: string;
-}
-export interface RemoteSourceConfig {
-    type: 'github' | 'gitlab' | 'raw';
-    /** e.g. "facebook/react" or "owner/repo" */
-    repo?: string;
-    /** e.g. "main" or "master" */
-    branch?: string;
-    /** Subdirectory where markdown files live, e.g. "docs" or "" */
-    docsDir?: string;
-    /** Optional personal access token or auth for private repos */
-    token?: string;
-    /** Raw base URL override */
-    baseUrl?: string;
-}
-export interface SidebarItemConfig {
-    title?: string;
-    path?: string;
-    slug?: string;
-    icon?: string;
-    badge?: string;
-    badgeType?: 'info' | 'success' | 'warning' | 'new';
-    collapsed?: boolean;
-    children?: SidebarItemConfig[];
-}
-export interface DocThemeConfig {
-    preset?: ThemePreset;
-    defaultMode?: ColorMode;
-    accentColor?: string;
-    accentColorDark?: string;
-    fontFamily?: string;
-    codeTheme?: 'github' | 'dracula' | 'one-dark' | 'synthwave';
-    logo?: {
-        light?: string;
-        dark?: string;
-        alt?: string;
-        text?: string;
-    };
-    favicon?: string;
-}
-export interface DocSearchConfig {
-    enabled?: boolean;
-    placeholder?: string;
-    maxResults?: number;
-}
-export interface DocConfig {
-    name: string;
-    tagline?: string;
-    description?: string;
-    version?: string;
-    rootDoc?: string;
-    /** Source configuration: local filesystem or remote GitHub/GitLab */
-    source?: RemoteSourceConfig;
-    /** Visual and theme configurations */
-    theme?: DocThemeConfig;
-    /** Navigation bar links */
-    nav?: NavLink[];
-    /** Social and repository links */
-    socials?: SocialLink[];
-    /** Manual sidebar configuration (optional; auto-indexed if omitted) */
-    sidebar?: SidebarItemConfig[];
-    /** Auto-indexing options */
-    autoIndex?: {
-        enabled?: boolean;
-        exclude?: string[];
-        sort?: 'alphabetical' | 'frontmatter' | 'natural';
-        defaultCollapsed?: boolean;
-    };
-    /** Search options */
-    search?: DocSearchConfig;
-    /** Footer config */
-    footer?: {
-        copyright?: string;
-        links?: NavLink[];
-        showBuiltWith?: boolean;
-    };
-    /** Custom component directory or URL */
-    componentsUrl?: string;
-    /** Edit page link (e.g. "https://github.com/owner/repo/edit/main/docs/") */
-    editUrl?: string;
-}
+/** DocMeDown runtime type definitions. Configuration types are derived from Zod schemas. */
+import type { z } from "zod";
+import type { colorModeSchema, docConfigSchema, docSearchConfigSchema, docThemeConfigSchema, navLinkSchema, normalizedDocConfigSchema, remoteSourceSchema, SidebarItemConfigShape, socialLinkSchema, themePresetSchema } from "./config-schema";
+export type ThemePreset = z.infer<typeof themePresetSchema>;
+export type ColorMode = z.infer<typeof colorModeSchema>;
+export type NavLink = z.infer<typeof navLinkSchema>;
+export type SocialLink = z.infer<typeof socialLinkSchema>;
+export type RemoteSourceConfig = z.infer<typeof remoteSourceSchema>;
+export type GithubSourceConfig = Extract<RemoteSourceConfig, {
+    type: "github";
+}>;
+export type GitlabSourceConfig = Extract<RemoteSourceConfig, {
+    type: "gitlab";
+}>;
+export type RawSourceConfig = Extract<RemoteSourceConfig, {
+    type: "raw";
+}>;
+export type SidebarItemConfig = SidebarItemConfigShape;
+export type DocThemeConfig = z.infer<typeof docThemeConfigSchema>;
+export type DocSearchConfig = z.infer<typeof docSearchConfigSchema>;
+export type PartialDocConfig = z.input<typeof docConfigSchema>;
+export type DocConfig = z.output<typeof normalizedDocConfigSchema>;
 /** Options accepted by the browser integration entry point. */
 export interface DocMeDownInitOptions {
     el?: string | HTMLElement;
-    config?: Partial<DocConfig>;
+    config?: PartialDocConfig;
     basePath?: string;
 }
 /** Handle returned after mounting DocMeDown into a page. */
@@ -118,7 +44,7 @@ export interface DocFrontmatter {
     description?: string;
     icon?: string;
     badge?: string;
-    badge_type?: 'info' | 'success' | 'warning' | 'new';
+    badge_type?: "info" | "success" | "warning" | "new";
     tags?: string[];
     hidden?: boolean;
     [key: string]: any;
@@ -148,7 +74,7 @@ export interface SidebarTreeNode {
     path?: string;
     icon?: string;
     badge?: string;
-    badgeType?: 'info' | 'success' | 'warning' | 'new';
+    badgeType?: "info" | "success" | "warning" | "new";
     order: number;
     isCategory: boolean;
     collapsed?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docmedown",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The simplest MarkDown documenter yet. CLI & Web Script React SPA documentation engine.",
   "main": "./dist/docmedown.cjs",
   "module": "./dist/docmedown.mjs",
@@ -23,6 +23,7 @@
     "dist",
     "bin",
     "templates",
+    "schemas",
     "README.md",
     "LICENSE"
   ],
@@ -31,6 +32,9 @@
     "build:runtime": "vite build",
     "build:cli": "tsup",
     "typecheck": "tsc --noEmit",
+    "lint": "biome check .",
+    "lint:fix": "biome check --write .",
+    "format": "biome format --write .",
     "build:types": "tsc -p tsconfig.runtime.json",
     "build": "npm run build:runtime && npm run build:cli && npm run build:types",
     "docmedown": "node ./bin/docmedown.js",
@@ -43,7 +47,9 @@
     "build:offline": "node ./bin/docmedown.js build ./docs",
     "config:docs": "node ./bin/docmedown.js config ./docs/docs.json",
     "test": "npx tsx --test tests/parser.test.ts tests/scanner.test.ts tests/runtime-integration.test.ts tests/package-smoke.test.ts",
-    "test:release": "npm run typecheck && npm run test && npm run build && npm run build:docs && npm pack --dry-run",
+    "test:release": "npm run typecheck && npm run lint && npm run test && npm run build && npm run build:docs && npm pack --dry-run",
+    "deploy": "node ./scripts/deploy.mjs",
+    "deploy:dry-run": "npm run deploy -- --dry-run",
     "prepublishOnly": "npm run test:release"
   },
   "keywords": [
@@ -85,9 +91,11 @@
     "mime-types": "^2.1.35",
     "open": "^10.1.0",
     "prompts": "^2.4.2",
-    "ws": "^8.18.0"
+    "ws": "^8.18.0",
+    "zod": "^4.4.3"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.5.10",
     "@types/node": "^22.5.0",
     "@types/prismjs": "^1.26.6",
     "@types/prompts": "^2.4.9",

package/schemas/docs.schema.json

@@ -0,0 +1,157 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/gabrielmsilva00/docmedown/main/schemas/docs.schema.json",
+  "title": "DocMeDown documentation configuration",
+  "description": "Configuration for a DocMeDown documentation root. A directory containing docs.json is an independent documentation site.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": { "type": "string", "format": "uri" },
+    "name": { "type": "string", "minLength": 1 },
+    "tagline": { "type": "string" },
+    "description": { "type": "string" },
+    "version": { "type": "string" },
+    "rootDoc": { "type": "string", "minLength": 1 },
+    "source": { "$ref": "#/$defs/source" },
+    "theme": { "$ref": "#/$defs/theme" },
+    "nav": { "type": "array", "items": { "$ref": "#/$defs/navLink" } },
+    "socials": { "type": "array", "items": { "$ref": "#/$defs/socialLink" } },
+    "sidebar": { "type": "array", "items": { "$ref": "#/$defs/sidebarItem" } },
+    "autoIndex": { "$ref": "#/$defs/autoIndex" },
+    "search": { "$ref": "#/$defs/search" },
+    "footer": { "$ref": "#/$defs/footer" },
+    "componentsUrl": { "type": "string" },
+    "editUrl": { "type": "string" }
+  },
+  "$defs": {
+    "navLink": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["label", "href"],
+      "properties": {
+        "label": { "type": "string", "minLength": 1 },
+        "href": { "type": "string", "minLength": 1 },
+        "external": { "type": "boolean" },
+        "icon": { "type": "string" }
+      }
+    },
+    "socialLink": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "url"],
+      "properties": {
+        "type": { "enum": ["github", "gitlab", "twitter", "x", "discord", "custom"] },
+        "url": { "type": "string", "format": "uri" },
+        "label": { "type": "string" },
+        "icon": { "type": "string" }
+      }
+    },
+    "source": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "repo"],
+          "properties": {
+            "type": { "const": "github" },
+            "repo": { "type": "string", "pattern": "^[^/\\s]+/[^/\\s]+$" },
+            "branch": { "type": "string", "minLength": 1 },
+            "docsDir": { "type": "string" },
+            "token": { "type": "string" },
+            "baseUrl": { "type": "string", "format": "uri" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "repo"],
+          "properties": {
+            "type": { "const": "gitlab" },
+            "repo": { "type": "string", "pattern": "^[^/\\s]+/[^/\\s]+$" },
+            "branch": { "type": "string", "minLength": 1 },
+            "docsDir": { "type": "string" },
+            "token": { "type": "string" },
+            "baseUrl": { "type": "string", "format": "uri" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "baseUrl"],
+          "properties": {
+            "type": { "const": "raw" },
+            "baseUrl": { "type": "string", "format": "uri" },
+            "branch": { "type": "string", "minLength": 1 },
+            "docsDir": { "type": "string" },
+            "token": { "type": "string" }
+          }
+        }
+      ]
+    },
+    "theme": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "preset": { "enum": ["indigo", "emerald", "sunset", "violet", "rose", "slate", "cyberpunk"] },
+        "defaultMode": { "enum": ["light", "dark", "auto"] },
+        "accentColor": { "type": "string" },
+        "accentColorDark": { "type": "string" },
+        "fontFamily": { "type": "string" },
+        "codeTheme": { "enum": ["github", "dracula", "one-dark", "synthwave"] },
+        "favicon": { "type": "string" },
+        "logo": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "light": { "type": "string" },
+            "dark": { "type": "string" },
+            "alt": { "type": "string" },
+            "text": { "type": "string" }
+          }
+        }
+      }
+    },
+    "autoIndex": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "exclude": { "type": "array", "items": { "type": "string", "minLength": 1 } },
+        "sort": { "enum": ["alphabetical", "frontmatter", "natural"] },
+        "defaultCollapsed": { "type": "boolean" }
+      }
+    },
+    "search": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "placeholder": { "type": "string" },
+        "maxResults": { "type": "integer", "minimum": 1, "maximum": 100 }
+      }
+    },
+    "footer": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "copyright": { "type": "string" },
+        "links": { "type": "array", "items": { "$ref": "#/$defs/navLink" } },
+        "showBuiltWith": { "type": "boolean" }
+      }
+    },
+    "sidebarItem": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "title": { "type": "string" },
+        "path": { "type": "string" },
+        "slug": { "type": "string" },
+        "icon": { "type": "string" },
+        "badge": { "type": "string" },
+        "badgeType": { "enum": ["info", "success", "warning", "new"] },
+        "collapsed": { "type": "boolean" },
+        "children": { "type": "array", "items": { "$ref": "#/$defs/sidebarItem" } }
+      }
+    }
+  }
+}

package/templates/docs.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://raw.githubusercontent.com/gabrielmsilva00/docmedown/main/schemas/docs.schema.json",
   "name": "My Project Docs",
   "tagline": "The simplest Markdown documentation yet",
   "description": "Fast, modern documentation created with DocMeDown",