@usecross/docs 0.7.0 → 0.8.1
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.
- package/dist/index.d.ts +10 -4
- package/dist/index.js +306 -145
- package/dist/index.js.map +1 -1
- package/dist/ssr.d.ts +1 -1
- package/dist/{types-DlF8TX2Q.d.ts → types-DlTTA3Dc.d.ts} +15 -1
- package/package.json +1 -1
- package/src/components/DocsLayout.tsx +11 -0
- package/src/components/DocsPage.tsx +6 -1
- package/src/components/Markdown.tsx +45 -0
- package/src/components/TableOfContents.tsx +180 -0
- package/src/components/index.ts +1 -0
- package/src/index.ts +3 -0
- package/src/types.ts +16 -0
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import * as react_jsx_runtime from 'react/jsx-runtime';
|
|
2
|
-
import { C as CodeBlockProps, D as DocSetMeta, a as DocsLayoutProps, b as DocContent, M as MarkdownProps, S as SidebarProps, c as DocsAppConfig } from './types-
|
|
3
|
-
export { N as NavItem, d as NavSection, e as SharedProps } from './types-
|
|
2
|
+
import { C as CodeBlockProps, D as DocSetMeta, a as DocsLayoutProps, b as DocContent, M as MarkdownProps, S as SidebarProps, T as TableOfContentsProps, c as DocsAppConfig } from './types-DlTTA3Dc.js';
|
|
3
|
+
export { N as NavItem, d as NavSection, e as SharedProps, f as TOCItem } from './types-DlTTA3Dc.js';
|
|
4
4
|
import { ReactNode } from 'react';
|
|
5
5
|
import { ClassValue } from 'clsx';
|
|
6
6
|
import { HighlighterCore } from 'shiki/core';
|
|
@@ -30,7 +30,7 @@ declare function DocSetSelector({ docSets, currentDocSet, className }: DocSetSel
|
|
|
30
30
|
/**
|
|
31
31
|
* Full-featured documentation layout with sidebar, mobile menu, and header.
|
|
32
32
|
*/
|
|
33
|
-
declare function DocsLayout({ children, title, description: _description, logo, logoInverted, logoUrl: propLogoUrl, logoInvertedUrl: propLogoInvertedUrl, githubUrl: propGithubUrl, navLinks: propNavLinks, footer, }: DocsLayoutProps): react_jsx_runtime.JSX.Element;
|
|
33
|
+
declare function DocsLayout({ children, title, description: _description, logo, logoInverted, logoUrl: propLogoUrl, logoInvertedUrl: propLogoInvertedUrl, githubUrl: propGithubUrl, navLinks: propNavLinks, footer, toc, }: DocsLayoutProps): react_jsx_runtime.JSX.Element;
|
|
34
34
|
|
|
35
35
|
interface DocsPageProps extends Omit<DocsLayoutProps, 'children' | 'title'> {
|
|
36
36
|
content: DocContent;
|
|
@@ -157,6 +157,12 @@ declare function Markdown({ content, components }: MarkdownProps): react_jsx_run
|
|
|
157
157
|
*/
|
|
158
158
|
declare function Sidebar({ nav, currentPath, className, docSets, currentDocSet }: SidebarProps): react_jsx_runtime.JSX.Element;
|
|
159
159
|
|
|
160
|
+
/**
|
|
161
|
+
* Table of contents component with scroll spy functionality.
|
|
162
|
+
* Displays "ON THIS PAGE" sidebar with heading links.
|
|
163
|
+
*/
|
|
164
|
+
declare function TableOfContents({ items, className }: TableOfContentsProps): react_jsx_runtime.JSX.Element | null;
|
|
165
|
+
|
|
160
166
|
type Theme = 'light' | 'dark' | 'system';
|
|
161
167
|
type ResolvedTheme = 'light' | 'dark';
|
|
162
168
|
interface ThemeContextValue {
|
|
@@ -227,4 +233,4 @@ declare function configureHighlighter(options: {
|
|
|
227
233
|
langs?: Promise<any>[];
|
|
228
234
|
}): void;
|
|
229
235
|
|
|
230
|
-
export { CodeBlock, CodeBlockProps, DocContent, DocSetMeta, DocSetSelector, DocsAppConfig, DocsLayout, DocsLayoutProps, DocsPage, EmojiConfetti, HomeCTA, type HomeFeature, HomeFeatureItem, type HomeFeatureItemProps, HomeFeatures, type HomeFeaturesProps, HomeFooter, HomeHeader, type HomeHeaderProps, HomeHero, HomePage, type HomePageContextValue, type HomePageProps, InlineCode, Markdown, MarkdownProps, type ResolvedTheme, Sidebar, SidebarProps, type Theme, ThemeProvider, ThemeToggle, cn, configureHighlighter, createDocsApp, getHighlighter, themeInitScript, useTheme };
|
|
236
|
+
export { CodeBlock, CodeBlockProps, DocContent, DocSetMeta, DocSetSelector, DocsAppConfig, DocsLayout, DocsLayoutProps, DocsPage, EmojiConfetti, HomeCTA, type HomeFeature, HomeFeatureItem, type HomeFeatureItemProps, HomeFeatures, type HomeFeaturesProps, HomeFooter, HomeHeader, type HomeHeaderProps, HomeHero, HomePage, type HomePageContextValue, type HomePageProps, InlineCode, Markdown, MarkdownProps, type ResolvedTheme, Sidebar, SidebarProps, TableOfContents, TableOfContentsProps, type Theme, ThemeProvider, ThemeToggle, cn, configureHighlighter, createDocsApp, getHighlighter, themeInitScript, useTheme };
|