@alliance-droid/svelte-docs-system 0.0.2 → 0.1.0

package/docs/en/api/examples.md

@@ -1,100 +0,0 @@
----
-title: API Examples
-description: Code examples for using the documentation system
-author: Andrew
-date: 2026-02-05
----
-
-# API Examples
-
-Here are practical examples of using the documentation system.
-
-## Loading a Document
-
-```typescript
-import { loadMarkdownBySlug } from '$lib/markdown';
-
-const doc = await loadMarkdownBySlug('./docs', 'setup');
-
-console.log(doc.title);        // "Setup Guide"
-console.log(doc.slug);         // "setup"
-console.log(doc.html);         // <h1>Setup Guide</h1>...
-console.log(doc.metadata);     // { title, author, date }
-```
-
-## Scanning All Documents
-
-```typescript
-import { scanDocsFolder, getSlugs } from '$lib/scanner';
-
-const structure = await scanDocsFolder('./docs');
-const slugs = getSlugs(structure);
-
-slugs.forEach(slug => {
-  console.log(`Found: ${slug}`);
-});
-// Output:
-// Found: index
-// Found: setup
-// Found: routing
-// Found: api/overview
-// Found: api/examples
-```
-
-## Building Navigation
-
-```typescript
-import { scanDocsFolder, buildNavStructure } from '$lib/scanner';
-
-const structure = await scanDocsFolder('./docs');
-const nav = buildNavStructure(structure);
-
-// nav contains hierarchical structure for building sidebar
-console.log(nav);
-```
-
-## In a SvelteKit Route
-
-```typescript
-// src/routes/docs/[...slug]/+page.ts
-import { loadMarkdownBySlug } from '$lib/markdown';
-import { error } from '@sveltejs/kit';
-
-export async function load({ params }) {
-  const slug = params.slug || 'index';
-  const doc = await loadMarkdownBySlug('./docs', slug);
-  
-  if (!doc) {
-    throw error(404, 'Page not found');
-  }
-  
-  return { doc };
-}
-```
-
-## Extracting Metadata
-
-```typescript
-import { extractMetadata } from '$lib/markdown';
-
-const meta = await extractMetadata('./docs/setup.md');
-console.log(meta);
-// { title: 'Setup Guide', author: 'Andrew', date: '2026-02-05' }
-```
-
-## Generating Table of Contents
-
-```typescript
-import { loadMarkdownBySlug, generateTableOfContents } from '$lib/markdown';
-
-const doc = await loadMarkdownBySlug('./docs', 'setup');
-const toc = generateTableOfContents(doc.html);
-
-toc.forEach(item => {
-  console.log(`${'  '.repeat(item.level - 2)}${item.text}`);
-});
-```
-
-## Next Steps
-
-Explore the [Routing System](/docs/routing) to learn more about how the system works.

package/docs/en/api/overview.md

@@ -1,69 +0,0 @@
----
-title: API Overview
-description: Overview of the documentation system API
-author: Andrew
-date: 2026-02-05
----
-
-# API Overview
-
-The documentation system provides utility functions for working with markdown files and routing.
-
-## Core Utilities
-
-### scanDocsFolder(docsPath: string)
-
-Scans the docs folder and returns a structure of all markdown files.
-
-```typescript
-const structure = await scanDocsFolder('./docs');
-// Returns: { 'setup': {...}, 'api/overview': {...} }
-```
-
-### loadMarkdownBySlug(docsPath: string, slug: string)
-
-Loads and parses a markdown file by its slug.
-
-```typescript
-const doc = await loadMarkdownBySlug('./docs', 'setup');
-// Returns: { content, html, metadata, slug, title }
-```
-
-### generateTableOfContents(htmlContent: string)
-
-Generates a table of contents from rendered markdown.
-
-```typescript
-const toc = generateTableOfContents(htmlContent);
-// Returns: [{ level: 2, text: 'Setup', id: 'setup' }, ...]
-```
-
-## Data Types
-
-### ParsedMarkdown
-
-```typescript
-interface ParsedMarkdown {
-  content: string;           // Raw markdown
-  html: string;              // Rendered HTML
-  metadata: FrontMatter;     // YAML frontmatter
-  slug: string;              // URL slug
-  title: string;             // Page title
-}
-```
-
-### FrontMatter
-
-```typescript
-interface FrontMatter {
-  title?: string;
-  description?: string;
-  author?: string;
-  date?: string;
-  [key: string]: any;        // Custom fields
-}
-```
-
-## Examples
-
-See [API Examples](/docs/api/examples) for complete code samples.