@opendocsdev/cli 0.2.0

package/dist/templates/components.mdx

@@ -0,0 +1,286 @@
+---
+title: Components
+description: Built-in MDX components to enhance your documentation
+---
+
+# Components
+
+opendocs includes several built-in components to create rich, interactive documentation.
+
+## Callout
+
+Use callouts to highlight important information, warnings, tips, or errors.
+
+<Callout type="info">
+
+This is an **info** callout. Use it for general information and notes.
+
+</Callout>
+
+<Callout type="tip">
+
+This is a **tip** callout. Use it for helpful suggestions and best practices.
+
+</Callout>
+
+<Callout type="warning">
+
+This is a **warning** callout. Use it to caution readers about potential issues.
+
+</Callout>
+
+<Callout type="error">
+
+This is an **error** callout. Use it for critical information or common mistakes.
+
+</Callout>
+
+```mdx
+<Callout type="info">
+  Your message here. Supports **markdown** formatting.
+</Callout>
+```
+
+### Callout Types
+
+| Type | Usage |
+|------|-------|
+| `info` | General information (default) |
+| `tip` | Helpful suggestions |
+| `warning` | Cautions and potential issues |
+| `error` | Critical warnings or common mistakes |
+
+## Code Groups
+
+Display code examples in multiple languages or package managers with tabs.
+
+<CodeGroup>
+```javascript JavaScript
+const greeting = "Hello, World!";
+console.log(greeting);
+```
+
+```python Python
+greeting = "Hello, World!"
+print(greeting)
+```
+
+```rust Rust
+fn main() {
+    println!("Hello, World!");
+}
+```
+</CodeGroup>
+
+````mdx
+<CodeGroup>
+```javascript JavaScript
+const greeting = "Hello, World!";
+```
+
+```python Python
+greeting = "Hello, World!"
+```
+</CodeGroup>
+````
+
+## Cards
+
+Use cards to create navigation links or highlight features.
+
+<CardGroup cols={2}>
+  <Card title="Getting Started" description="Learn the basics of opendocs" href="/quickstart" icon="🚀" />
+  <Card title="Configuration" description="Customize your documentation site" href="/configuration" icon="⚙️" />
+  <Card title="Components" description="Explore built-in MDX components" href="/components" icon="🧩" />
+  <Card title="Writing Content" description="Learn how to write effective docs" href="/writing-content" icon="✍️" />
+</CardGroup>
+
+```mdx
+<CardGroup cols={2}>
+  <Card
+    title="Getting Started"
+    description="Learn the basics"
+    href="/quickstart"
+    icon="🚀"
+  />
+  <Card
+    title="Configuration"
+    description="Customize your site"
+    href="/configuration"
+    icon="⚙️"
+  />
+</CardGroup>
+```
+
+### Card Props
+
+| Prop | Type | Description |
+|------|------|-------------|
+| `title` | string | Card title (required) |
+| `description` | string | Short description |
+| `href` | string | Link destination |
+| `icon` | string | Emoji or icon character |
+
+### CardGroup Props
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `cols` | 1, 2, 3, 4 | 2 | Number of columns |
+
+## Steps
+
+Create numbered step-by-step instructions.
+
+<Steps>
+
+### Install the CLI
+
+Install opendocs globally using npm, yarn, or pnpm.
+
+### Initialize your project
+
+Run `opendocs init my-docs` to create a new documentation project.
+
+### Start the dev server
+
+Run `opendocs dev` to preview your documentation locally.
+
+### Deploy
+
+Build and deploy your documentation to any static hosting service.
+
+</Steps>
+
+```mdx
+<Steps>
+
+### Step One
+
+Description for step one.
+
+### Step Two
+
+Description for step two.
+
+### Step Three
+
+Description for step three.
+
+</Steps>
+```
+
+<Callout type="tip">
+
+Steps automatically number each child heading (h3, h4, etc.) and display them with a connected timeline.
+
+</Callout>
+
+## Combining Components
+
+Components can be nested and combined for more complex layouts.
+
+### Steps with Cards
+
+Use Cards inside Steps to provide navigation options at each stage:
+
+<Steps>
+
+### Choose your setup
+
+<CardGroup cols={2}>
+  <Card title="Quick Start" description="Get running in minutes" href="/quickstart" icon="⚡" />
+  <Card title="Manual Setup" description="Full control over configuration" href="/configuration" icon="🔧" />
+</CardGroup>
+
+### Configure your project
+
+<Callout type="info">
+
+Edit `docs.json` to customize navigation, theme, and features.
+
+</Callout>
+
+### Write your content
+
+Create `.mdx` files and start documenting your project.
+
+</Steps>
+
+### Cards with Code Examples
+
+Combine explanatory cards with code samples:
+
+<CardGroup cols={2}>
+  <Card title="Frontend" description="React, Vue, or vanilla JS" icon="🖥️" />
+  <Card title="Backend" description="Node.js, Python, or Go" icon="⚙️" />
+</CardGroup>
+
+<CodeGroup>
+```javascript React
+import { useState } from 'react';
+
+function App() {
+  const [count, setCount] = useState(0);
+  return <button onClick={() => setCount(count + 1)}>{count}</button>;
+}
+```
+
+```python FastAPI
+from fastapi import FastAPI
+
+app = FastAPI()
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
+```
+</CodeGroup>
+
+### Callouts in Context
+
+Use callouts within other components to highlight important information:
+
+<Steps>
+
+### Install dependencies
+
+```bash
+pnpm install
+```
+
+<Callout type="warning">
+
+Make sure you have Node.js 18+ installed before proceeding.
+
+</Callout>
+
+### Start development
+
+```bash
+pnpm dev
+```
+
+<Callout type="tip">
+
+The dev server supports hot reload - changes appear instantly!
+
+</Callout>
+
+</Steps>
+
+### Feature Comparison Tables
+
+Combine tables with callouts for feature documentation:
+
+| Feature | Free | Pro | Enterprise |
+|---------|------|-----|------------|
+| Pages | 10 | 100 | Unlimited |
+| Custom domain | No | Yes | Yes |
+| Analytics | Basic | Advanced | Advanced |
+| Support | Community | Email | Dedicated |
+
+<Callout type="info">
+
+All plans include search, dark mode, and responsive design.
+
+</Callout>

package/dist/templates/configuration.mdx

@@ -0,0 +1,190 @@
+---
+title: Configuration
+description: Configure your documentation site with docs.json
+---
+
+# Configuration
+
+All configuration for your opendocs site lives in a single `docs.json` file at the root of your project.
+
+## Basic Configuration
+
+Here's a minimal configuration to get started:
+
+```json
+{
+  "name": "My Documentation",
+  "logo": "/logo.svg",
+  "navigation": [
+    {
+      "group": "Getting Started",
+      "pages": ["introduction", "quickstart"]
+    }
+  ]
+}
+```
+
+## Full Configuration Reference
+
+```json
+{
+  "name": "My Documentation",
+  "logo": "/logo.svg",
+  "favicon": "/favicon.ico",
+  "navigation": [
+    {
+      "group": "Getting Started",
+      "pages": ["introduction", "quickstart"]
+    },
+    {
+      "group": "Guides",
+      "pages": ["components", "configuration", "writing-content"]
+    },
+    {
+      "group": "API",
+      "pages": ["api-reference"]
+    }
+  ],
+  "theme": {
+    "primaryColor": "#0066cc",
+    "darkMode": true
+  },
+  "features": {
+    "search": true,
+    "feedback": false,
+    "analytics": false
+  }
+}
+```
+
+## Configuration Options
+
+### name
+
+The name of your documentation site. Displayed in the header and browser tab.
+
+```json
+{
+  "name": "Acme Documentation"
+}
+```
+
+### logo
+
+Path to your logo image. Place the file in the `public` directory.
+
+```json
+{
+  "logo": "/logo.svg"
+}
+```
+
+<Callout type="tip">
+  SVG logos are recommended as they scale well and support dark mode.
+</Callout>
+
+### favicon
+
+Path to your favicon. Defaults to the logo if not specified.
+
+```json
+{
+  "favicon": "/favicon.ico"
+}
+```
+
+### navigation
+
+Define the sidebar navigation structure. Organize pages into groups.
+
+```json
+{
+  "navigation": [
+    {
+      "group": "Getting Started",
+      "pages": ["introduction", "quickstart"]
+    },
+    {
+      "group": "API Reference",
+      "pages": ["api/authentication", "api/endpoints"]
+    }
+  ]
+}
+```
+
+<Callout type="info">
+  Page paths are relative to the project root. A page `api/authentication` maps to `api/authentication.mdx`.
+</Callout>
+
+### theme
+
+Customize the visual appearance of your documentation.
+
+```json
+{
+  "theme": {
+    "primaryColor": "#0066cc",
+    "darkMode": true
+  }
+}
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `primaryColor` | string | `#0066cc` | Primary brand color for links, buttons, etc. |
+| `darkMode` | boolean | `true` | Enable dark mode toggle |
+
+### features
+
+Enable or disable built-in features.
+
+```json
+{
+  "features": {
+    "search": true,
+    "feedback": false,
+    "analytics": false
+  }
+}
+```
+
+| Feature | Type | Default | Description |
+|---------|------|---------|-------------|
+| `search` | boolean | `true` | Enable full-text search (powered by Pagefind) |
+| `feedback` | boolean | `false` | Show "Was this helpful?" feedback widget |
+| `analytics` | boolean | `false` | Enable page view analytics |
+
+## File Structure
+
+A typical opendocs project structure:
+
+```
+my-docs/
+├── docs.json           # Configuration file
+├── introduction.mdx    # Documentation pages
+├── quickstart.mdx
+├── guides/
+│   ├── components.mdx
+│   └── configuration.mdx
+├── api/
+│   └── reference.mdx
+└── public/
+    ├── logo.svg        # Static assets
+    └── favicon.ico
+```
+
+<Callout type="warning">
+  Page files must have the `.mdx` extension. Regular `.md` files are not supported.
+</Callout>
+
+## Environment Variables
+
+opendocs supports the following environment variables:
+
+| Variable | Description |
+|----------|-------------|
+| `PORT` | Development server port (default: 4321) |
+
+```bash
+PORT=3000 opendocs dev
+```

package/dist/templates/docs.json

@@ -0,0 +1,27 @@
+{
+  "name": "{{PROJECT_NAME}}",
+  "logo": "/logo.svg",
+  "navigation": [
+    {
+      "group": "Getting Started",
+      "pages": ["introduction", "quickstart"]
+    },
+    {
+      "group": "Guides",
+      "pages": ["components", "configuration", "writing-content"]
+    },
+    {
+      "group": "API",
+      "pages": ["api-reference"]
+    }
+  ],
+  "theme": {
+    "primaryColor": "#0066cc",
+    "darkMode": true
+  },
+  "features": {
+    "search": true,
+    "feedback": false,
+    "analytics": false
+  }
+}

package/dist/templates/introduction.mdx

@@ -0,0 +1,25 @@
+---
+title: Introduction
+description: Welcome to the documentation
+---
+
+# Introduction
+
+Welcome to your new documentation site! This is built with **opendocs**, an open-source Mintlify alternative.
+
+<Callout type="info">
+  This is an example callout. You can use callouts to highlight important information.
+</Callout>
+
+## What is opendocs?
+
+opendocs is a modern documentation generator that allows you to write beautiful docs with zero configuration. Features include:
+
+- **MDX Support** - Write content in Markdown with JSX components
+- **Full-text Search** - Built-in search powered by Pagefind
+- **Dark Mode** - Automatic dark mode support
+- **Analytics & Feedback** - Track pageviews and collect reader feedback
+
+## Next Steps
+
+Check out the [Quickstart](/quickstart) guide to get started with your documentation.

package/dist/templates/logo.svg

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" width="40" height="40">
+  <rect width="100" height="100" rx="20" fill="#0066cc"/>
+  <text x="50" y="65" font-family="system-ui, sans-serif" font-size="40" font-weight="bold" fill="white" text-anchor="middle">D</text>
+</svg>

package/dist/templates/quickstart.mdx

@@ -0,0 +1,59 @@
+---
+title: Quickstart
+description: Get started with opendocs in minutes
+---
+
+# Quickstart
+
+Follow these steps to get your documentation site up and running.
+
+## Installation
+
+Install the opendocs CLI globally using your preferred package manager:
+
+<CodeGroup>
+```bash npm
+npm install -g @opendocsdev/cli
+```
+
+```bash yarn
+yarn global add @opendocsdev/cli
+```
+
+```bash pnpm
+pnpm add -g @opendocsdev/cli
+```
+</CodeGroup>
+
+## Create a New Project
+
+Initialize a new documentation project:
+
+```bash
+opendocs init my-docs
+cd my-docs
+```
+
+## Start the Development Server
+
+Run the development server with hot reload:
+
+```bash
+opendocs dev
+```
+
+Your documentation site is now running at `http://localhost:4321`.
+
+## Build for Production
+
+When you're ready to deploy, build your site:
+
+```bash
+opendocs build
+```
+
+This creates an optimized build in the `dist` folder, ready for deployment to any static hosting service.
+
+<Callout type="tip">
+  You can preview the production build locally by running `opendocs preview`.
+</Callout>