@clidey/dory 0.27.0 → 0.30.0

package/scripts/generate-frontmatter-json.js

@@ -1,154 +0,0 @@
-#!/usr/bin/env node
-
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-// Read dory.json to get navigation order (flat list, in order)
-function getNavigationOrder(docsDir) {
-  const doryJsonPath = path.join(docsDir, 'dory.json');
-  if (!fs.existsSync(doryJsonPath)) return [];
-  const doryJson = JSON.parse(fs.readFileSync(doryJsonPath, 'utf-8'));
-  const order = [];
-
-  function walkPages(pages) {
-    for (const page of pages) {
-      if (typeof page === 'string') {
-        order.push(page);
-      } else if (typeof page === 'object' && page.pages) {
-        walkPages(page.pages);
-      }
-    }
-  }
-
-  if (doryJson.navigation && Array.isArray(doryJson.navigation.tabs)) {
-    for (const tab of doryJson.navigation.tabs) {
-      if (tab.groups && Array.isArray(tab.groups)) {
-        for (const group of tab.groups) {
-          if (group.pages && Array.isArray(group.pages)) {
-            walkPages(group.pages);
-          }
-        }
-      }
-    }
-  }
-  return order;
-}
-
-// Function to parse frontmatter from MDX content
-function parseFrontmatter(content) {
-  const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---/);
-  if (!frontmatterMatch) return { data: {}, content };
-  
-  const frontmatter = frontmatterMatch[1];
-  const data = {};
-  
-  frontmatter.split('\n').forEach(line => {
-    const [key, ...valueParts] = line.split(':');
-    if (key && valueParts.length) {
-      const value = valueParts.join(':').trim();
-      data[key.trim()] = value.replace(/^["']|["']$/g, '');
-    }
-  });
-
-  return { data, content: content.slice(frontmatterMatch[0].length) };
-}
-
-// Convert filename to path format used by the store
-function pathFromFilename(filename, docsDir) {
-  return filename
-    .replace(docsDir, '')
-    .replace(/\/?index\.mdx$/, '/')
-    .replace(/\.mdx$/, '')
-    .replace(/\\/g, '/')
-    .toLowerCase();
-}
-
-// Function to recursively find all MDX files and map by relative path (without .mdx)
-function findMdxFilesMap(dir, baseDir) {
-  const files = {};
-  const items = fs.readdirSync(dir, { withFileTypes: true });
-
-  for (const item of items) {
-    const fullPath = path.join(dir, item.name);
-    if (item.isDirectory()) {
-      Object.assign(files, findMdxFilesMap(fullPath, baseDir));
-    } else if (item.isFile() && item.name.endsWith('.mdx')) {
-      // Key: relative path without .mdx, with forward slashes
-      let rel = path.relative(baseDir, fullPath).replace(/\\/g, '/');
-      if (rel.endsWith('.mdx')) rel = rel.slice(0, -4);
-      files[rel] = fullPath;
-    }
-  }
-
-  return files;
-}
-
-// Main function to generate frontmatter JSON
-async function generateFrontmatterJson() {
-  const docsDir = path.join(__dirname, '..', 'docs');
-  const outputDir = path.join(__dirname, '..', 'dist');
-  
-  // Ensure output directory exists
-  if (!fs.existsSync(outputDir)) {
-    fs.mkdirSync(outputDir, { recursive: true });
-  }
-  
-  const navOrder = getNavigationOrder(docsDir);
-  const mdxFilesMap = findMdxFilesMap(docsDir, docsDir);
-  const usedKeys = new Set();
-  const frontmatterArray = [];
-
-  // Process files in navigation order first
-  for (const navKey of navOrder) {
-    // Try both with and without "index"
-    let fileKey = navKey;
-    if (mdxFilesMap[fileKey]) {
-      usedKeys.add(fileKey);
-    } else if (mdxFilesMap[`${fileKey}/index`]) {
-      fileKey = `${fileKey}/index`;
-      usedKeys.add(fileKey);
-    } else {
-      continue;
-    }
-
-    const filePath = mdxFilesMap[fileKey];
-    const rawContent = fs.readFileSync(filePath, 'utf-8');
-    const { data } = parseFrontmatter(rawContent);
-    const pathname = pathFromFilename(filePath, docsDir);
-
-    frontmatterArray.push({
-      ...data,
-      path: pathname
-    });
-  }
-
-  // Process any extra files not in navigation order, sorted
-  const extraKeys = Object.keys(mdxFilesMap).filter(k => !usedKeys.has(k)).sort();
-  for (const fileKey of extraKeys) {
-    const filePath = mdxFilesMap[fileKey];
-    const rawContent = fs.readFileSync(filePath, 'utf-8');
-    const { data } = parseFrontmatter(rawContent);
-    const pathname = pathFromFilename(filePath, docsDir);
-
-    frontmatterArray.push({
-      ...data,
-      path: pathname
-    });
-  }
-
-  // Write to output file
-  const jsonContent = JSON.stringify(frontmatterArray, null, 2);
-  const outputPath = path.join(outputDir, 'frontmatter.json');
-  fs.writeFileSync(outputPath, jsonContent);
-  
-  console.log(`✅ Generated frontmatter JSON file: ${outputPath}`);
-  console.log(`📄 Processed ${frontmatterArray.length} MDX files`);
-  console.log(`📝 Total JSON size: ${jsonContent.length} characters`);
-}
-
-// Run the script
-generateFrontmatterJson().catch(console.error);

package/scripts/generate-llm-txt.js

@@ -1,115 +0,0 @@
-#!/usr/bin/env node
-
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-// Function to parse frontmatter from MDX content
-function parseFrontmatter(content) {
-  const frontmatterMatch = content.match(/^---\n([\s\S]*?)\n---\n/);
-  if (!frontmatterMatch) return { data: {}, content };
-  
-  const frontmatter = frontmatterMatch[1];
-  const data = {};
-  
-  frontmatter.split('\n').forEach(line => {
-    const [key, ...valueParts] = line.split(':');
-    if (key && valueParts.length) {
-      const value = valueParts.join(':').trim();
-      data[key.trim()] = value.replace(/^["']|["']$/g, '');
-    }
-  });
-
-  return { data, content: content.slice(frontmatterMatch[0].length) };
-}
-
-// Function to recursively find all MDX files
-function findMdxFiles(dir) {
-  const files = [];
-  const items = fs.readdirSync(dir, { withFileTypes: true });
-  
-  for (const item of items) {
-    const fullPath = path.join(dir, item.name);
-    if (item.isDirectory()) {
-      files.push(...findMdxFiles(fullPath));
-    } else if (item.isFile() && item.name.endsWith('.mdx')) {
-      files.push(fullPath);
-    }
-  }
-  
-  return files;
-}
-
-// Function to clean MDX content for LLM consumption
-function cleanMdxContent(content) {
-  // Remove JSX components but keep their content
-  let cleaned = content
-    // Remove JSX opening/closing tags but keep content
-    .replace(/<(\w+)([^>]*?)>/g, '')
-    .replace(/<\/\w+>/g, '')
-    // Remove code block language specifiers
-    .replace(/```(\w+)/g, '```')
-    // Remove HTML comments
-    .replace(/<!--[\s\S]*?-->/g, '')
-    // Remove excessive whitespace
-    .replace(/\n\s*\n\s*\n/g, '\n\n')
-    // Remove leading/trailing whitespace
-    .trim();
-    
-  return cleaned;
-}
-
-// Main function to generate LLM text
-async function generateLlmTxt() {
-  const docsDir = path.join(__dirname, '..', 'docs');
-  const outputDir = path.join(__dirname, '..', 'dist');
-  
-  // Ensure output directory exists
-  if (!fs.existsSync(outputDir)) {
-    fs.mkdirSync(outputDir, { recursive: true });
-  }
-  
-  const mdxFiles = findMdxFiles(docsDir);
-  let aggregatedContent = '';
-  
-  // Sort files for consistent output
-  mdxFiles.sort();
-  
-  for (const filePath of mdxFiles) {
-    const rawContent = fs.readFileSync(filePath, 'utf-8');
-    const { data, content } = parseFrontmatter(rawContent);
-    const cleanedContent = cleanMdxContent(content);
-    
-    // Add file header
-    const relativePath = path.relative(docsDir, filePath);
-    aggregatedContent += `\n# ${relativePath}\n`;
-    
-    // Add title if available
-    if (data.title) {
-      aggregatedContent += `## ${data.title}\n\n`;
-    }
-    
-    // Add description if available
-    if (data.description) {
-      aggregatedContent += `${data.description}\n\n`;
-    }
-    
-    // Add cleaned content
-    aggregatedContent += cleanedContent + '\n\n';
-    aggregatedContent += '---\n\n';
-  }
-  
-  // Write to output file
-  const outputPath = path.join(outputDir, 'llms.txt');
-  fs.writeFileSync(outputPath, aggregatedContent.trim());
-  
-  console.log(`✅ Generated LLM text file: ${outputPath}`);
-  console.log(`📄 Processed ${mdxFiles.length} MDX files`);
-  console.log(`📝 Total content size: ${aggregatedContent.length} characters`);
-}
-
-// Run the script
-generateLlmTxt().catch(console.error);

package/src/app.css

@@ -1,5 +0,0 @@
-@import "tailwindcss";
-
-@custom-variant dark (&:where(.dark, .dark *));
-
-

package/src/app.tsx

@@ -1,13 +0,0 @@
-import './app.css'
-import './theme.scss'
-import Routes from './components/routes'
-
-export function App() {
-  return (
-    <div className="h-full antialiased">
-      <div className="flex min-h-full">
-        <Routes />
-      </div>
-    </div>
-  )
-}

package/src/components/dropdown.tsx

@@ -1,53 +0,0 @@
-import {
-  DropdownMenu,
-  DropdownMenuTrigger,
-  DropdownMenuContent,
-  DropdownMenuItem,
-  DropdownMenuSeparator,
-  Button
-} from '@clidey/ux'
-import { ChevronDownIcon } from '@heroicons/react/20/solid'
-import type { ComponentChildren } from 'preact'
-import type { ReactNode } from 'preact/compat'
-
-interface DropdownItem {
-  icon?: ComponentChildren
-  label: string
-  href?: string
-  onClick?: () => void
-  divider?: boolean
-}
-
-interface DropdownProps {
-  buttonLabel: string | ReactNode;
-  items: DropdownItem[]
-  className?: string
-}
-
-export default function Dropdown({ buttonLabel, items, className = '' }: DropdownProps) {
-  return (
-    <DropdownMenu>
-      <DropdownMenuTrigger>
-        <Button className={className}>
-          {buttonLabel}
-          <ChevronDownIcon className="ml-2 h-4 w-4" />
-        </Button>
-      </DropdownMenuTrigger>
-      <DropdownMenuContent>
-        {items.map((item, index) => (
-          <>
-            {item.divider && index > 0 && <DropdownMenuSeparator />}
-            <DropdownMenuItem
-              key={index}
-              onClick={item.onClick}
-              className="cursor-pointer"
-            >
-              {item.icon && <span className="mr-2">{item.icon}</span>}
-              {item.label}
-            </DropdownMenuItem>
-          </>
-        ))}
-      </DropdownMenuContent>
-    </DropdownMenu>
-  )
-}

package/src/components/hooks.tsx

@@ -1,28 +0,0 @@
-import { useEffect, useState } from 'preact/hooks';
-import { useLocation } from 'wouter-preact';
-
-/**
- * Custom hook to get the current pathname
- */
-export const usePathname = () => {
-  const [pathname] = useLocation();
-  return pathname;
-};
-
-/**
- * Custom hook to get the URL search params as a URLSearchParams instance
- */
-export const useSearchParams = () => {
-  const [searchParams, setSearchParams] = useState(new URLSearchParams(window.location.search));
-
-  useEffect(() => {
-    const handlePopState = () => {
-      setSearchParams(new URLSearchParams(window.location.search));
-    };
-
-    window.addEventListener('popstate', handlePopState);
-    return () => window.removeEventListener('popstate', handlePopState);
-  }, []);
-
-  return searchParams;
-};

package/src/components/loading.tsx

@@ -1,21 +0,0 @@
-import { Spinner } from '@clidey/ux';
-import classNames from "classnames";
-
-type ILoadingProps = {
-  className?: string;
-  showText?: boolean;
-  loadingText?: string;
-  textClassName?: string;
-}
-
-export const Loading = ({ className, showText = false, loadingText, textClassName }: ILoadingProps) => {
-  return (
-    <div className="h-full w-full flex flex-col justify-center items-center gap-2 min-h-[400px]" role="status">
-      <Spinner className={className} />
-      {
-        showText &&
-        <div className={classNames("text-sm text-gray-500", textClassName)}>{ loadingText ?? "Loading..."}</div>
-      }
-    </div>
-  )
-}

package/src/components/mdx-provider.tsx

@@ -1,13 +0,0 @@
-import { MDXProvider } from '@mdx-js/preact';
-import Layout from '../ui/layout';
-import * as mdx from '../mdx/mdx';
-
-export const withMDX = (Content: preact.ComponentType) => () => {
-  return (
-    <MDXProvider components={mdx}>
-      <Layout>
-        <Content />
-      </Layout>
-    </MDXProvider>
-  );
-};

package/src/components/navigation.tsx

@@ -1,58 +0,0 @@
-import classNames from 'classnames';
-import { useMemo } from 'preact/hooks';
-import { Link } from 'wouter-preact';
-import { usePathname } from './hooks';
-import { ALL_NAVIGATION } from './store';
-
-export function Navigation() {
-    const pathname = usePathname();
-
-    const effectivePath = pathname === '/' 
-        ? ALL_NAVIGATION[0]?.groups[0]?.pages[0]?.href ?? '/' 
-        : pathname;
-
-    const currentTab = useMemo(() => {
-        return ALL_NAVIGATION.find(tab => 
-            tab.groups.some(group => 
-                group.pages.some(page => page.href === effectivePath)
-            )
-        );
-    }, [effectivePath]);
-
-    return (
-        <nav className="dory-navigation text-base lg:text-sm">
-            <ul role="list" className="space-y-9">
-                {currentTab && (
-                <li key={currentTab.title}>
-                    <h2 className="font-display font-medium text-xs">{currentTab.title}</h2>
-                    {currentTab.groups.map(group => (
-                        <div key={group.title}>
-                            <h3 className="mt-4 text-sm font-semibold">{group.title}</h3>
-                            <ul role="list" className="mt-2 space-y-2 border-l-2 border-slate-100 lg:mt-4 lg:space-y-4 lg:border-slate-200 dark:border-slate-800">
-                                {group.pages.map((page) => {
-                                    const isActive = effectivePath === page.href;
-                                    return (
-                                        <li key={page.href} className="relative">
-                                            <Link
-                                                href={page.href}
-                                                className={classNames(
-                                                'block w-full pl-3.5 before:pointer-events-none before:absolute before:top-1/2 before:-left-1 before:h-1.5 before:w-1.5 before:-translate-y-1/2 before:rounded-full',
-                                                {
-                                                    'font-semibold text-brand-foreground': isActive,
-                                                    'text-slate-500 before:hidden before:bg-slate-300 hover:text-slate-600 hover:before:block dark:text-slate-400 dark:before:bg-slate-700 dark:hover:text-slate-300': !isActive
-                                                },
-                                            )}>
-                                                {page.title}
-                                            </Link>
-                                        </li>
-                                    );
-                                })}
-                            </ul>
-                        </div>
-                    ))}
-                </li>
-                )}
-            </ul>
-        </nav>
-    );
-}

package/src/components/notification.tsx

@@ -1,13 +0,0 @@
-import { toast } from '@clidey/ux';
-import { InfoIcon } from 'lucide-react';
-
-export function useNotification() {
-  return {
-    showNotification: (message: string, description?: string) => {
-      toast(message, {
-        icon: <InfoIcon className="h-4 w-4" />,
-        description: description,
-      });
-    }
-  };
-}

package/src/components/routes.tsx

@@ -1,92 +0,0 @@
-import { useEffect, useState } from 'preact/hooks';
-import { Route, Router, useLocation } from 'wouter-preact';
-import { usePathname } from './hooks';
-import { ALL_NAVIGATION, ALL_PAGES, pathFromFilename } from './store';
-import { Loading } from './loading';
-
-
-export default function Routes() {
-  const [routes, setRoutes] = useState<any[]>([]);
-  const pathname = usePathname();
-  const [, navigate] = useLocation();
-  const [loading, setLoading] = useState(true);
-
-  useEffect(() => {
-    const links = document.querySelectorAll('.dory-navigation a');
-    const listeners: (() => void)[] = [];
-    const preloaded = new Set();
-  
-    links.forEach(link => {
-      const href = link.getAttribute('href');
-      if (!href) return;
-  
-      const loaderEntry = Object.entries(ALL_PAGES).find(
-        ([path]) => path === href
-      );
-  
-      if (!loaderEntry) return;
-  
-      const [path, loader] = loaderEntry;
-  
-      const handleMouseEnter = () => {
-        if (!preloaded.has(path)) {
-          loader();
-          preloaded.add(path);
-        }
-      };
-  
-      link.addEventListener('mouseenter', handleMouseEnter);
-      listeners.push(() => link.removeEventListener('mouseenter', handleMouseEnter));
-    });
-  
-    return () => {
-      listeners.forEach(unsub => unsub());
-    };
-  }, []);
-
-  useEffect(() => {
-    setLoading(true);
-    const loadRoutes = async () => {
-      // For root path, load the first navigation page
-      const targetPath = pathname === '/' ? ALL_NAVIGATION[0].groups[0].pages[0].href : pathname;
-      
-      const entries = await Promise.all(
-        Object.entries(ALL_PAGES).filter(([path]) => path === targetPath).map(async ([path, loader]) => {
-          const module = await loader();
-          const routePath = pathname === '/' ? '/' : pathFromFilename(path);
-          return {
-            path: routePath,
-            component: module.default,
-          };
-        })
-      );  
-      setRoutes(entries);
-      setLoading(false);
-    };
-
-    loadRoutes();
-  }, [pathname]);
-
-  useEffect(() => {
-    const page = ALL_NAVIGATION.find((tab) => tab.groups.find((group) => group.pages.find((page) => page.href === pathname)));
-    if (!page && pathname !== '/') {
-      navigate(ALL_NAVIGATION[0].groups[0].pages[0].href);
-      window.location.reload();
-    }
-  }, [routes, pathname]);
-
-  useEffect(() => {
-    window.scrollTo({ top: 0, behavior: 'smooth' });
-  }, [pathname]);
-  
-
-  if (loading) return <div className="h-[25vh] flex grow"><Loading /></div>;
-
-  return (
-    <Router>
-      {routes.map(({ path, component: Component }) => (
-        <Route key={path} path={path} component={Component} />
-      ))}
-    </Router>
-  );
-}

package/src/components/search-index.ts

@@ -1,43 +0,0 @@
-import { Document } from "flexsearch";
-
-export const searchIndex = new Document({
-    tokenize: 'full',
-    document: {
-        id: 'url',
-        index: 'content',
-        store: ['title', 'pageTitle'],
-    },
-    context: {
-        resolution: 9,
-        depth: 2,
-        bidirectional: true
-    }
-});
-
-export function addToSearchIndex(filename: string, data: any, content: string) {
-    searchIndex.add({
-        url: filename,
-        title: data.title || '',
-        content: content,
-        pageTitle: data.title
-    });
-}
-
-export function search(query: string, options = {}) {
-    if (!searchIndex) return [];
-    
-    const result = searchIndex.search(query, {
-        ...options,
-        enrich: true,
-    });
-
-    if (result.length === 0) {
-        return [];
-    }
-
-    return result[0].result.map((item) => ({
-        url: item.id,
-        title: item.doc?.title || '',
-        pageTitle: item.doc?.pageTitle || '',
-    }));
-}