@arkenv/fumadocs-ui 0.0.2 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +57 -57
  2. package/dist/components/index.d.cts +9 -9
  3. package/package.json +6 -2
package/README.md CHANGED
@@ -1,57 +1,57 @@
1
- # @arkenv/fumadocs-ui
2
-
3
- A Fumadocs-ready component and theme package for ArkEnv documentation. It ships sharpened Tailwind v4 styling, external link handling, enhanced headings/code blocks, AI actions, and a ready-to-use MDX component map.
4
-
5
- ## Highlights
6
- - Design system CSS with 0.125rem radius and 80px header/nav height overrides
7
- - External link detection with safe targets and visual indicators
8
- - Anchorable headings with scroll margin for tall headers
9
- - Enhanced code blocks and AI actions (copy markdown, open in AI assistants)
10
- - Preconfigured `arkenvComponents` MDX map that layers our overrides onto `fumadocs-ui` defaults
11
-
12
- ## Install
13
- Ensure peer dependencies from `fumadocs-ui` are available, then install:
14
-
15
- ```bash
16
- pnpm add @arkenv/fumadocs-ui
17
- ```
18
-
19
- ## Style entry
20
- Import the theme CSS once (Tailwind v4 style):
21
-
22
- ```css
23
- /* e.g. apps/www/app/globals.css */
24
- @import "@arkenv/fumadocs-ui/css/theme.css";
25
- ```
26
-
27
- ## MDX components
28
- Use the prebuilt mapping in your MDX provider:
29
-
30
- ```ts
31
- import { arkenvComponents } from "@arkenv/fumadocs-ui/mdx";
32
-
33
- export const mdxComponents = {
34
- ...arkenvComponents,
35
- };
36
- ```
37
-
38
- ## Components
39
- Client components suitable for Next.js App Router:
40
-
41
- ```tsx
42
- import { AIActions, CodeBlock, ExternalLink, Heading } from "@arkenv/fumadocs-ui/components";
43
-
44
- // Example
45
- <Heading as="h2" id="getting-started">Getting started</Heading>
46
- <ExternalLink href="https://arkenv.js.org">Docs</ExternalLink>
47
- ```
48
-
49
- ## Utilities
50
-
51
- ```ts
52
- import { isExternalUrl, cn } from "@arkenv/fumadocs-ui/utils";
53
- ```
54
-
55
- ## Notes
56
- - Components are client-side and include the required `"use client"` directives in the published bundle.
57
- - CSS overrides Fumadocs defaults; no additional config is needed beyond importing `theme.css`.
1
+ # @arkenv/fumadocs-ui
2
+
3
+ A Fumadocs-ready component and theme package for ArkEnv documentation. It ships sharpened Tailwind v4 styling, external link handling, enhanced headings/code blocks, AI actions, and a ready-to-use MDX component map.
4
+
5
+ ## Highlights
6
+ - Design system CSS with 0.125rem radius and 80px header/nav height overrides
7
+ - External link detection with safe targets and visual indicators
8
+ - Anchorable headings with scroll margin for tall headers
9
+ - Enhanced code blocks and AI actions (copy markdown, open in AI assistants)
10
+ - Preconfigured `arkenvComponents` MDX map that layers our overrides onto `fumadocs-ui` defaults
11
+
12
+ ## Install
13
+ Ensure peer dependencies from `fumadocs-ui` are available, then install:
14
+
15
+ ```bash
16
+ pnpm add @arkenv/fumadocs-ui
17
+ ```
18
+
19
+ ## Style entry
20
+ Import the theme CSS once (Tailwind v4 style):
21
+
22
+ ```css
23
+ /* e.g. apps/www/app/globals.css */
24
+ @import "@arkenv/fumadocs-ui/css/theme.css";
25
+ ```
26
+
27
+ ## MDX components
28
+ Use the prebuilt mapping in your MDX provider:
29
+
30
+ ```ts
31
+ import { arkenvComponents } from "@arkenv/fumadocs-ui/mdx";
32
+
33
+ export const mdxComponents = {
34
+ ...arkenvComponents,
35
+ };
36
+ ```
37
+
38
+ ## Components
39
+ Client components suitable for Next.js App Router:
40
+
41
+ ```tsx
42
+ import { AIActions, CodeBlock, ExternalLink, Heading } from "@arkenv/fumadocs-ui/components";
43
+
44
+ // Example
45
+ <Heading as="h2" id="getting-started">Getting started</Heading>
46
+ <ExternalLink href="https://arkenv.js.org">Docs</ExternalLink>
47
+ ```
48
+
49
+ ## Utilities
50
+
51
+ ```ts
52
+ import { isExternalUrl, cn } from "@arkenv/fumadocs-ui/utils";
53
+ ```
54
+
55
+ ## Notes
56
+ - Components are client-side and include the required `"use client"` directives in the published bundle.
57
+ - CSS overrides Fumadocs defaults; no additional config is needed beyond importing `theme.css`.
package/dist/components/index.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- import * as react_jsx_runtime6 from "react/jsx-runtime";
1
+ import * as react_jsx_runtime0 from "react/jsx-runtime";
2
2
  import { Tabs, TabsContent, TabsList, TabsTrigger } from "fumadocs-ui/components/tabs";
3
3
  import { ComponentProps, ComponentPropsWithoutRef, FC, HTMLAttributes, ReactNode } from "react";
4
4
  import FumadocsLink from "fumadocs-core/link";
@@ -10,7 +10,7 @@ declare function AIActions({
10
10
  }: {
11
11
  markdownUrl: string;
12
12
  githubUrl: string;
13
- }): react_jsx_runtime6.JSX.Element;
13
+ }): react_jsx_runtime0.JSX.Element;
14
14
  //#endregion
15
15
  //#region src/components/code-blocks.d.ts
16
16
  interface CodeBlockProps extends ComponentProps<"figure"> {
@@ -48,7 +48,7 @@ interface CodeBlockProps extends ComponentProps<"figure"> {
48
48
  children?: ReactNode;
49
49
  }) => ReactNode;
50
50
  }
51
- declare function Pre(props: ComponentProps<"pre">): react_jsx_runtime6.JSX.Element;
51
+ declare function Pre(props: ComponentProps<"pre">): react_jsx_runtime0.JSX.Element;
52
52
  declare function CodeBlock({
53
53
  ref,
54
54
  title,
@@ -59,17 +59,17 @@ declare function CodeBlock({
59
59
  children,
60
60
  Actions,
61
61
  ...props
62
- }: CodeBlockProps): react_jsx_runtime6.JSX.Element;
62
+ }: CodeBlockProps): react_jsx_runtime0.JSX.Element;
63
63
  declare function CodeBlockTabs({
64
64
  ref,
65
65
  ...props
66
- }: ComponentProps<typeof Tabs>): react_jsx_runtime6.JSX.Element;
67
- declare function CodeBlockTabsList(props: ComponentProps<typeof TabsList>): react_jsx_runtime6.JSX.Element;
66
+ }: ComponentProps<typeof Tabs>): react_jsx_runtime0.JSX.Element;
67
+ declare function CodeBlockTabsList(props: ComponentProps<typeof TabsList>): react_jsx_runtime0.JSX.Element;
68
68
  declare function CodeBlockTabsTrigger({
69
69
  children,
70
70
  ...props
71
- }: ComponentProps<typeof TabsTrigger>): react_jsx_runtime6.JSX.Element;
72
- declare function CodeBlockTab(props: ComponentProps<typeof TabsContent>): react_jsx_runtime6.JSX.Element;
71
+ }: ComponentProps<typeof TabsTrigger>): react_jsx_runtime0.JSX.Element;
72
+ declare function CodeBlockTab(props: ComponentProps<typeof TabsContent>): react_jsx_runtime0.JSX.Element;
73
73
  //#endregion
74
74
  //#region src/components/external-link.d.ts
75
75
  interface ExternalLinkProps extends ComponentProps<typeof FumadocsLink> {
@@ -91,6 +91,6 @@ declare function Heading<T extends Types = "h1">({
91
91
  className,
92
92
  children,
93
93
  ...props
94
- }: HeadingProps<T>): react_jsx_runtime6.JSX.Element;
94
+ }: HeadingProps<T>): react_jsx_runtime0.JSX.Element;
95
95
  //#endregion
96
96
  export { AIActions, CodeBlock, CodeBlockProps, CodeBlockTab, CodeBlockTabs, CodeBlockTabsList, CodeBlockTabsTrigger, ExternalLink, ExternalLinkProps, Heading, Pre };
package/package.json CHANGED
@@ -1,7 +1,11 @@
1
1
  {
2
2
  "name": "@arkenv/fumadocs-ui",
3
- "version": "0.0.2",
3
+ "version": "0.0.3",
4
4
  "type": "module",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "git+https://github.com/yamcodes/arkenv.git"
8
+ },
5
9
  "exports": {
6
10
  "./css/*": "./css/*",
7
11
  "./mdx": {
@@ -57,7 +61,7 @@
57
61
  "react": "19.2.3",
58
62
  "react-dom": "19.2.3",
59
63
  "rimraf": "6.1.2",
60
- "rollup-plugin-preserve-use-client": "^3.0.1",
64
+ "rollup-plugin-preserve-use-client": "3.0.1",
61
65
  "tailwindcss": "4.1.18",
62
66
  "tsdown": "0.19.0",
63
67
  "typescript": "5.9.3"