mordoc 0.1.1

package/README.md

@@ -0,0 +1,240 @@
+# Mordoc
+
+A modern static site generator for documentation with SSG + SPA capabilities. Build fast, SEO-friendly documentation sites with smooth client-side navigation.
+
+## Overview
+
+Mordoc combines the best of static site generation and single-page applications to deliver documentation sites that are:
+- **SEO-friendly** with pre-rendered HTML for every page
+- **Fast to navigate** with client-side routing after initial load
+- **Easy to write** using Markdown and Markdoc
+- **Customizable** with simple JSON configuration
+- **Multi-language ready** with built-in internationalization support
+
+## Key Features
+
+- 📄 **Markdoc-powered** - Write content in Markdown with powerful custom components
+- 🚀 **Static + SPA** - Pre-rendered HTML with smooth client-side navigation
+- 🔍 **Built-in Search** - Instant full-text search powered by Pagefind
+- 🌍 **Multi-language** - First-class support for internationalization
+- 🎨 **Customizable Theming** - Configure colors and styles with simple JSON
+- ⚡ **React-based** - Modern React 19 for component rendering
+- 📱 **Responsive** - Mobile-friendly by default
+
+## Installation
+
+Create a new Mordoc documentation site using `create-mordoc-app`:
+
+```bash
+npm create mordoc-app my-docs
+```
+
+> **Note:** The `create-mordoc-app` package is not yet published. Coming soon!
+
+Or with other package managers:
+
+```bash
+# Using yarn
+yarn create mordoc-app my-docs
+
+# Using pnpm
+pnpm create mordoc-app my-docs
+```
+
+## Quick Start
+
+1. **Create a new project:**
+
+```bash
+npm create mordoc-app my-docs
+cd my-docs
+```
+
+2. **Build your documentation:**
+
+```bash
+npm run build
+```
+
+3. **Start the development server:**
+
+```bash
+npm run dev
+```
+
+Your documentation site will be available at `http://localhost:3000`
+
+## CLI Commands
+
+### `mordoc build`
+
+Generate the static documentation site.
+
+```bash
+mordoc build [options]
+```
+
+**Options:**
+
+| Option | Alias | Description | Default |
+|--------|-------|-------------|---------|
+| `--output <dir>` | `-o` | Output directory | `dist` |
+| `--verbose` | `-v` | Enable verbose logging | `false` |
+| `--drafts` | `-d` | Include draft content in build | `false` |
+| `--no-clean` | | Don't clean output directory before build | `false` |
+| `--help` | `-h` | Show help message | |
+
+**Examples:**
+
+```bash
+# Basic build
+mordoc build
+
+# Build to custom directory
+mordoc build --output build
+
+# Build with drafts and verbose output
+mordoc build --verbose --drafts
+```
+
+### `mordoc dev`
+
+Start the development server to preview your documentation.
+
+```bash
+mordoc dev [options]
+```
+
+**Options:**
+
+| Option | Alias | Description | Default |
+|--------|-------|-------------|---------|
+| `--port <number>` | `-p` | Port number | `3000` |
+| `--host <host>` | `-h` | Host address | `localhost` |
+| `--open` | `-o` | Open browser automatically | `false` |
+| `--help` | | Show help message | |
+
+**Examples:**
+
+```bash
+# Start dev server on default port
+mordoc dev
+
+# Use custom port
+mordoc dev --port 8080
+
+# Make accessible on network
+mordoc dev --host 0.0.0.0
+```
+
+> **Note:** The dev server serves the pre-built `dist/` folder. Run `mordoc build` first and rebuild manually after making changes.
+
+## Project Structure
+
+After creating a new project, you'll have the following structure:
+
+```
+my-docs/
+├── content/              # Your markdown content files
+│   └── en/              # English content (default language)
+│       ├── index.md     # Homepage
+│       ├── getting-started.md
+│       └── guides/
+│           └── first-steps.md
+├── config/              # Configuration files
+│   ├── site.json       # Site metadata and settings
+│   ├── sidenav.yaml    # Sidebar navigation structure
+│   └── styles/         # Theme customization
+├── public/              # Static assets (images, fonts, etc.)
+├── dist/               # Generated site (after build)
+├── package.json
+└── node_modules/
+```
+
+## Configuration
+
+Mordoc uses simple configuration files in the `config/` directory:
+
+- **`site.json`** - Site metadata (title, description, base URL)
+- **`sidenav.yaml`** - Sidebar navigation structure
+- **`styles/`** - Theme colors and customization
+
+For detailed configuration options and syntax, see the [Mordoc Documentation](#) *(coming soon)*.
+
+## Content Writing
+
+Write your documentation using Markdown with Markdoc enhancements:
+
+```markdown
+---
+title: My Page Title
+description: Page description for SEO
+order: 1
+---
+
+# My Page Title
+
+Your content here...
+```
+
+### Frontmatter
+
+Each markdown file supports frontmatter for metadata:
+
+- `title` - Page title
+- `description` - Page description (for SEO)
+- `order` - Sort order in navigation
+- `draft` - Mark as draft (excluded unless `--drafts` flag used)
+
+For complete documentation on content writing, Markdoc syntax, and custom components, visit the [Mordoc Documentation](#) *(coming soon)*.
+
+## Development Workflow
+
+1. **Write content** - Add or edit markdown files in `content/`
+2. **Build** - Run `npm run build` to generate the static site
+3. **Preview** - Run `npm run dev` to preview locally
+4. **Iterate** - Make changes and rebuild
+
+## Deployment
+
+Mordoc generates a fully static site in the `dist/` directory. Deploy it to any static hosting service:
+
+- **Netlify** - Drag and drop the `dist/` folder or connect your git repo
+- **Vercel** - Import your project and set build command to `npm run build`
+- **GitHub Pages** - Push the `dist/` folder to your gh-pages branch
+- **AWS S3** - Upload the `dist/` folder to an S3 bucket
+- **Any static host** - Upload the `dist/` folder contents
+
+Build command: `npm run build`  
+Output directory: `dist`
+
+## Requirements
+
+- **Node.js** >= 18.0.0
+- **npm** >= 9.0.0 (or yarn/pnpm equivalent)
+
+## Technology Stack
+
+Mordoc is built with modern web technologies:
+
+- [Markdoc](https://markdoc.dev/) - Markdown authoring framework
+- [React 19](https://react.dev/) - UI rendering
+- [React Router](https://reactrouter.com/) - Client-side routing
+- [Pagefind](https://pagefind.app/) - Static search
+- [esbuild](https://esbuild.github.io/) - Fast bundling
+- [Prism.js](https://prismjs.com/) - Syntax highlighting
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
+
+## License
+
+MIT
+
+---
+
+**Documentation:** [https://mordoc.dev](#) *(coming soon)*  
+**Issues:** [GitHub Issues](#)  
+**NPM:** [mordoc](#) *(not yet published)*
+

package/bin/cli.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+const path = require('path');
+const fs = require('fs');
+
+// Get the command from arguments
+const args = process.argv.slice(2);
+const command = args[0];
+const commandArgs = args.slice(1); // Arguments after the command
+
+// Display help text
+function showHelp() {
+  console.log(`
+Mordoc - Static Site Generator for Documentation
+
+Usage:
+  mordoc <command> [options]
+
+Commands:
+  build      Build the documentation site
+  dev        Start the development server
+  
+Options:
+  --help     Show this help message
+
+Examples:
+  mordoc build
+  mordoc build --verbose --drafts
+  mordoc dev
+  mordoc dev --port 8080
+  `);
+}
+
+// Main CLI logic
+async function main() {
+  // Show help if no command or --help flag
+  if (!command || command === '--help' || command === '-h') {
+    showHelp();
+    process.exit(0);
+  }
+
+  // Check if dist folder exists (TypeScript must be compiled first)
+  const distPath = path.join(__dirname, '../dist/cli');
+  if (!fs.existsSync(distPath)) {
+    console.error('Error: Mordoc is not built. Please run "tsc" first to compile TypeScript.');
+    process.exit(1);
+  }
+
+  // Route to appropriate command handler
+  try {
+    switch (command) {
+      case 'build': {
+        const buildHandler = require('../dist/cli/build.js');
+        const options = buildHandler.parseBuildArgs(commandArgs);
+        await buildHandler.build(options);
+        break;
+      }
+      
+      case 'dev': {
+        const devHandler = require('../dist/cli/dev.js');
+        const options = devHandler.parseDevArgs(commandArgs);
+        await devHandler.dev(options);
+        break;
+      }
+      
+      default:
+        console.error(`Unknown command: ${command}`);
+        showHelp();
+        process.exit(1);
+    }
+  } catch (error) {
+    console.error('Error:', error.message);
+    if (process.env.DEBUG) {
+      console.error(error.stack);
+    }
+    process.exit(1);
+  }
+}
+
+// Run the CLI
+main();

package/dist/build/Builder.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Builder - Main build orchestrator for Mordoc
+ * Coordinates the entire static site generation process
+ */
+export interface BuilderOptions {
+    projectRoot: string;
+    outputDir?: string;
+    clean?: boolean;
+    includeDrafts?: boolean;
+    verbose?: boolean;
+}
+export declare class Builder {
+    private projectRoot;
+    private outputDir;
+    private contentDir;
+    private configDir;
+    private publicDir;
+    private clean;
+    private includeDrafts;
+    private verbose;
+    constructor(options: BuilderOptions);
+    /**
+     * Execute the complete build process
+     */
+    build(): Promise<void>;
+    /**
+     * Load site configuration
+     */
+    private loadConfig;
+    /**
+     * Load and process all content files
+     */
+    private loadAndProcessContent;
+    /**
+     * Generate static HTML pages for all content
+     */
+    private generateHtmlPages;
+    /**
+     * Write HTML file for a content page
+     */
+    private writeHtmlFile;
+    /**
+     * Generate JSON data files for SPA navigation
+     */
+    private generateContentDataFiles;
+    /**
+     * Generate theme CSS and component styles
+     */
+    private generateThemeCSS;
+    /**
+     * Bundle client React application
+     */
+    private bundleClientApp;
+    /**
+     * Copy static assets (logo, favicon, public/ folder, and MORDOC fonts)
+     */
+    private copyStaticAssets;
+    /**
+     * Copy MORDOC's built-in assets (fonts, etc.)
+     */
+    private copyMordocAssets;
+    /**
+     * Generate client configuration JSON
+     */
+    private generateClientConfig;
+    /**
+     * Generate search index using Pagefind
+     */
+    private generateSearchIndex;
+    /**
+     * Clean output directory
+     */
+    private cleanOutputDir;
+    /**
+     * Ensure output directory exists
+     */
+    private ensureOutputDir;
+    /**
+     * Copy directory recursively
+     */
+    private copyDirectory;
+    /**
+     * Log message if verbose mode is enabled
+     */
+    private log;
+    /**
+     * Print build statistics
+     */
+    private printBuildStats;
+}
+//# sourceMappingURL=Builder.d.ts.map

package/dist/build/Builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Builder.d.ts","sourceRoot":"","sources":["../../src/build/Builder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,OAAO;IAClB,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,aAAa,CAAU;IAC/B,OAAO,CAAC,OAAO,CAAU;gBAEb,OAAO,EAAE,cAAc;IAWnC;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA2D5B;;OAEG;YACW,UAAU;IAKxB;;OAEG;YACW,qBAAqB;IAkBnC;;OAEG;YACW,iBAAiB;IAsB/B;;OAEG;IACH,OAAO,CAAC,aAAa;IAyBrB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAyDhC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAkBxB;;OAEG;YACW,eAAe;IAc7B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAwCxB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAkBxB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAc5B;;OAEG;YACW,mBAAmB;IAmBjC;;OAEG;IACH,OAAO,CAAC,cAAc;IAMtB;;OAEG;IACH,OAAO,CAAC,eAAe;IAMvB;;OAEG;IACH,OAAO,CAAC,aAAa;IAgBrB;;OAEG;IACH,OAAO,CAAC,GAAG;IAOX;;OAEG;IACH,OAAO,CAAC,eAAe;CAmBxB"}