docusaurus-plugin-gitbook 0.1.0

package/lib/theme-types.d.ts

@@ -0,0 +1,129 @@
+/**
+ * Shared types for GitBook theme components
+ */
+import type { ReactNode } from 'react';
+/**
+ * Tabs component props
+ */
+export interface TabsProps {
+    children: ReactNode;
+}
+/**
+ * Tab component props
+ */
+export interface TabProps {
+    title: string;
+    children: ReactNode;
+}
+/**
+ * Stepper component props
+ */
+export interface StepperProps {
+    children: ReactNode;
+}
+/**
+ * Step component props
+ */
+export interface StepProps {
+    stepNumber?: number;
+    children: ReactNode;
+}
+/**
+ * Columns component props
+ */
+export interface ColumnsProps {
+    children: ReactNode;
+}
+/**
+ * Column component props
+ */
+export interface ColumnProps {
+    children: ReactNode;
+}
+/**
+ * Updates component props
+ */
+export interface UpdatesProps {
+    format?: 'full' | 'compact';
+    children: ReactNode;
+}
+/**
+ * Update component props
+ */
+export interface UpdateProps {
+    date: string;
+    children: ReactNode;
+}
+/**
+ * CodeBlock component props
+ */
+export interface CodeBlockProps {
+    title: string;
+    lineNumbers?: boolean;
+    overflow?: 'wrap' | 'scroll';
+    children: ReactNode;
+}
+/**
+ * Embed component props
+ */
+export interface EmbedProps {
+    url: string;
+}
+/**
+ * File component props
+ */
+export interface FileProps {
+    src: string;
+    children?: ReactNode;
+}
+/**
+ * Cards component props
+ */
+export interface CardsProps {
+    children: ReactNode;
+}
+/**
+ * Card component props
+ */
+export interface CardProps {
+    title: string;
+    href: string;
+    children?: ReactNode;
+}
+/**
+ * Button component props
+ */
+export interface ButtonProps {
+    href: string;
+    variant?: 'primary' | 'secondary';
+    icon?: string;
+    children: ReactNode;
+}
+/**
+ * FAIcon component props
+ */
+export interface FAIconProps {
+    icon: string;
+}
+/**
+ * Expression component props
+ */
+export interface ExpressionProps {
+    expression: string;
+    value?: string;
+}
+/**
+ * Include component props
+ */
+export interface IncludeProps {
+    src: string;
+}
+/**
+ * OpenAPI component props
+ */
+export interface OpenAPIProps {
+    src: string;
+    path: string;
+    method: string;
+}
+//# sourceMappingURL=theme-types.d.ts.map

package/lib/theme-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme-types.d.ts","sourceRoot":"","sources":["../src/theme-types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAEvC;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC7B,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/lib/theme-types.js

@@ -0,0 +1,5 @@
+/**
+ * Shared types for GitBook theme components
+ */
+export {};
+//# sourceMappingURL=theme-types.js.map

package/lib/theme-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme-types.js","sourceRoot":"","sources":["../src/theme-types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "docusaurus-plugin-gitbook",
+  "version": "0.1.0",
+  "description": "Docusaurus plugin for MDX that adds support for GitBook-specific blocks",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "build": "tsc && yarn copy-assets",
+    "copy-assets": "find src -name '*.css' -exec sh -c 'mkdir -p lib/$(dirname ${1#src/}) && cp $1 lib/${1#src/}' _ {} \\;",
+    "watch": "tsc --watch",
+    "clean": "rm -rf lib",
+    "prepublishOnly": "yarn clean && yarn build",
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "docusaurus",
+    "plugin",
+    "gitbook",
+    "mdx",
+    "remark"
+  ],
+  "license": "MIT",
+  "packageManager": "yarn@4.12.0",
+  "workspaces": [
+    "docs"
+  ],
+  "peerDependencies": {
+    "@docusaurus/core": "^3.0.0",
+    "docusaurus-theme-openapi-docs": "^4.0.0 || ^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "docusaurus-theme-openapi-docs": {
+      "optional": true
+    }
+  },
+  "type": "module",
+  "devDependencies": {
+    "@docusaurus/core": "^3.7.0",
+    "@docusaurus/types": "^3.7.0",
+    "@eslint/js": "^10.0.1",
+    "@types/hast": "^3.0.4",
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.2.13",
+    "@types/react-dom": "^19.2.3",
+    "eslint": "^9.0.0",
+    "hast": "^1.0.0",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "rehype-parse": "^9.0.1",
+    "rehype-stringify": "^10.0.1",
+    "typescript": "^5.7.0",
+    "typescript-eslint": "^8.0.0",
+    "vitest": "^3.0.0"
+  },
+  "dependencies": {
+    "@types/mdast": "^4.0.4",
+    "mdast-util-mdx-jsx": "^3.2.0",
+    "remark-parse": "^11.0.0",
+    "unified": "^11.0.0",
+    "unist-util-visit": "^5.0.0"
+  }
+}