@eqtylab/docs 0.3.0

package/dist/types.d.ts

@@ -0,0 +1,60 @@
+/** Public types. Keep free of `astro:*` imports so this loads in Node. */
+export type BadgeVariant = 'primary' | 'secondary' | 'neutral' | 'success' | 'warning' | 'danger';
+export interface DocsBadge {
+    text: string;
+    variant: BadgeVariant;
+}
+/** A node in the sidebar tree. */
+export interface NavNode {
+    kind: 'page' | 'group' | 'link';
+    /** Filesystem name (basename without extension, or directory name). The `order` sort key. */
+    name: string;
+    label: string;
+    /** Absolute, base-prefixed href. Undefined for a group with no index page. */
+    href?: string;
+    /** Lucide icon name. */
+    icon?: string;
+    badge?: DocsBadge;
+    external?: boolean;
+    /** True when this node is the page being viewed. */
+    current?: boolean;
+    /** True when this node is the current page or an ancestor of it. */
+    inPath?: boolean;
+    /** Groups only: whether to render expanded. */
+    open?: boolean;
+    children?: NavNode[];
+    /** Extra attributes for `link` nodes. */
+    attrs?: Record<string, string | number | boolean>;
+}
+/** A heading in the on-this-page tree. */
+export interface TocNode {
+    depth: number;
+    slug: string;
+    text: string;
+    children: TocNode[];
+}
+/** The minimum a docs entry must expose for the nav builder. */
+export interface DocsNavEntry {
+    /** Collection id, e.g. "guides/installation" or "index". */
+    id: string;
+    /** On-disk path, relative to the project root. Needed to tell `index.mdx` from a page. */
+    filePath?: string;
+    label: string;
+    icon?: string;
+    badge?: DocsBadge;
+    hidden?: boolean;
+    draft?: boolean;
+}
+/** Extension point for generated sections (OpenAPI reference, changelogs, ...). */
+export interface DocsPlugin {
+    name: string;
+    setup(ctx: DocsPluginContext): void | Promise<void>;
+}
+export interface DocsPluginContext {
+    /** Push a top-level group into the sidebar. Appended after folder-derived nodes. */
+    addNavGroup(group: NavNode): void;
+    /** Merge entries into the route-level MDX component map. */
+    addMdxComponents(map: Record<string, unknown>): void;
+    /** Raw `astro:config:setup` params: injectRoute, updateConfig, addWatchFile, logger. */
+    astro: unknown;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+import './chunk-55J6XMHW.js';
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/package.json

@@ -0,0 +1,127 @@
+{
+  "name": "@eqtylab/docs",
+  "description": "Astro documentation framework built on the Equality design system",
+  "version": "0.3.0",
+  "license": "Apache-2.0",
+  "homepage": "https://equality.eqtylab.io/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eqtylab/equality.git",
+    "directory": "packages/docs"
+  },
+  "type": "module",
+  "keywords": [
+    "astro-integration",
+    "astro-component",
+    "withastro",
+    "documentation",
+    "docs"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./config": {
+      "types": "./dist/config.d.ts",
+      "default": "./dist/config.js"
+    },
+    "./env": {
+      "types": "./dist/env.d.ts",
+      "default": "./dist/env.js"
+    },
+    "./schema": {
+      "types": "./dist/schema.d.ts",
+      "default": "./dist/schema.js"
+    },
+    "./loaders": {
+      "types": "./dist/loaders.d.ts",
+      "default": "./dist/loaders.js"
+    },
+    "./nav": {
+      "types": "./dist/nav.d.ts",
+      "default": "./dist/nav.js"
+    },
+    "./paths": {
+      "types": "./dist/paths.d.ts",
+      "default": "./dist/paths.js"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "default": "./dist/types.js"
+    },
+    "./dev": {
+      "types": "./dist/dev.d.ts",
+      "default": "./dist/dev.js"
+    },
+    "./internal/rehype-base-url": {
+      "types": "./dist/internal/rehype-base-url.d.ts",
+      "default": "./dist/internal/rehype-base-url.js"
+    },
+    "./components": "./dist/runtime/components/index.ts",
+    "./components/*": "./dist/runtime/components/*",
+    "./chrome/*": "./dist/runtime/chrome/*",
+    "./layouts/*": "./dist/runtime/layouts/*",
+    "./routes/*": "./dist/runtime/routes/*",
+    "./scripts/*": "./dist/runtime/scripts/*",
+    "./styles.css": "./dist/runtime/styles/docs.css",
+    "./prose.css": "./dist/runtime/styles/prose.css",
+    "./theme.css": "./dist/runtime/styles/theme.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": [
+    "**/*.css",
+    "**/runtime/scripts/*"
+  ],
+  "engines": {
+    "node": ">=22.12"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm run check:source && pnpm run build:node && pnpm run build:runtime && pnpm run build:types",
+    "build:node": "tsup",
+    "build:dev": "pnpm run build:node && pnpm run build:runtime",
+    "build:runtime": "node scripts/copy-runtime.mjs",
+    "build:types": "tsc -p tsconfig.build.json",
+    "dev": "node scripts/dev.mjs",
+    "check:source": "node scripts/check-tailwind-source.mjs",
+    "test": "node --test tests/*.test.ts",
+    "release": "pnpm run build && pnpm publish --access public --no-git-checks"
+  },
+  "dependencies": {
+    "@tailwindcss/vite": "^4.1.16",
+    "github-slugger": "^2.0.0",
+    "pagefind": "^1.5.2",
+    "tailwindcss": "^4.1.16",
+    "tinyglobby": "^0.2.15",
+    "unist-util-visit": "^5.1.0",
+    "yaml": "^2.8.2"
+  },
+  "peerDependencies": {
+    "@astrojs/mdx": "^5.0.2",
+    "@astrojs/react": "^5.0.1",
+    "@eqtylab/equality": ">=3.2.6 <5",
+    "astro": "^6.0.0",
+    "react": "^18.2.0 || ^19.0.0",
+    "react-dom": "^18.2.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@eqtylab/equality": "workspace:*",
+    "@types/node": "^24.9.2",
+    "@types/react": "^19.2.2",
+    "@types/react-dom": "^19.2.2",
+    "astro": "^6.0.8",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "tsup": "^8.5.0",
+    "typescript": ">=5.4.x",
+    "vite": "^7.0.0"
+  }
+}