@opendocsdev/cli 0.2.0

package/src/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/src/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/src/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/src/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/src/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>

package/src/templates/writing-content.mdx

@@ -0,0 +1,236 @@
+---
+title: Writing Content
+description: Learn how to write effective documentation with MDX
+---
+
+# Writing Content
+
+opendocs uses MDX, which combines Markdown with JSX components for rich documentation.
+
+## Frontmatter
+
+Every page should start with frontmatter that defines metadata:
+
+```mdx
+---
+title: Page Title
+description: A brief description for SEO and previews
+---
+
+# Your Content Here
+```
+
+### Frontmatter Fields
+
+| Field | Required | Description |
+|-------|----------|-------------|
+| `title` | Yes | Page title (shown in browser tab and navigation) |
+| `description` | No | Short description for SEO and social sharing |
+
+## Markdown Basics
+
+opendocs supports all standard Markdown syntax.
+
+### Headings
+
+```markdown
+# Heading 1
+## Heading 2
+### Heading 3
+#### Heading 4
+```
+
+<Callout type="tip">
+  Use `##` (H2) for main sections. These appear in the "On this page" table of contents.
+</Callout>
+
+### Text Formatting
+
+| Syntax | Result |
+|--------|--------|
+| `**bold**` | **bold** |
+| `*italic*` | *italic* |
+| `~~strikethrough~~` | ~~strikethrough~~ |
+| `` `inline code` `` | `inline code` |
+
+### Lists
+
+**Unordered lists:**
+
+```markdown
+- First item
+- Second item
+  - Nested item
+  - Another nested item
+- Third item
+```
+
+- First item
+- Second item
+  - Nested item
+  - Another nested item
+- Third item
+
+**Ordered lists:**
+
+```markdown
+1. First step
+2. Second step
+3. Third step
+```
+
+1. First step
+2. Second step
+3. Third step
+
+### Links
+
+```markdown
+[Link text](https://example.com)
+[Internal link](/quickstart)
+```
+
+[Link text](https://example.com) | [Internal link](/quickstart)
+
+### Images
+
+Place images in the `public` directory and reference them:
+
+```markdown
+![Alt text](/images/screenshot.png)
+```
+
+### Tables
+
+```markdown
+| Header 1 | Header 2 | Header 3 |
+|----------|----------|----------|
+| Cell 1   | Cell 2   | Cell 3   |
+| Cell 4   | Cell 5   | Cell 6   |
+```
+
+| Header 1 | Header 2 | Header 3 |
+|----------|----------|----------|
+| Cell 1   | Cell 2   | Cell 3   |
+| Cell 4   | Cell 5   | Cell 6   |
+
+### Blockquotes
+
+```markdown
+> This is a blockquote. Use it to highlight quotes or important notes.
+```
+
+> This is a blockquote. Use it to highlight quotes or important notes.
+
+## Code Blocks
+
+### Basic Code Blocks
+
+Use triple backticks with a language identifier:
+
+```javascript
+function greet(name) {
+  return `Hello, ${name}!`;
+}
+```
+
+```javascript
+function greet(name) {
+  return `Hello, ${name}!`;
+}
+```
+
+### Supported Languages
+
+opendocs supports syntax highlighting for 100+ languages including:
+
+- JavaScript, TypeScript, JSX, TSX
+- Python, Ruby, Go, Rust
+- HTML, CSS, SCSS
+- JSON, YAML, TOML
+- Bash, Shell
+- SQL, GraphQL
+- And many more...
+
+### Code Groups for Multiple Languages
+
+Use the `CodeGroup` component to show code in multiple languages:
+
+<CodeGroup>
+```javascript Node.js
+const express = require('express');
+const app = express();
+
+app.get('/', (req, res) => {
+  res.send('Hello World!');
+});
+```
+
+```python Flask
+from flask import Flask
+app = Flask(__name__)
+
+@app.route('/')
+def hello():
+    return 'Hello World!'
+```
+
+```go Go
+package main
+
+import "net/http"
+
+func main() {
+    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+        w.Write([]byte("Hello World!"))
+    })
+    http.ListenAndServe(":8080", nil)
+}
+```
+</CodeGroup>
+
+## Using Components
+
+Import and use built-in components directly in your MDX:
+
+```mdx
+<Callout type="info">
+  This is an informational callout.
+</Callout>
+
+<CardGroup cols={2}>
+  <Card title="Card 1" description="Description" href="/page1" />
+  <Card title="Card 2" description="Description" href="/page2" />
+</CardGroup>
+```
+
+See the [Components](/components) page for all available components.
+
+## Best Practices
+
+<CardGroup cols={2}>
+  <Card
+    title="Keep it concise"
+    description="Write short paragraphs. Use lists and tables for clarity."
+    icon="✂️"
+  />
+  <Card
+    title="Use examples"
+    description="Show, don't tell. Include code samples and screenshots."
+    icon="💻"
+  />
+  <Card
+    title="Structure content"
+    description="Use headings to create a clear hierarchy."
+    icon="📋"
+  />
+  <Card
+    title="Add callouts"
+    description="Highlight important info, warnings, and tips."
+    icon="💡"
+  />
+</CardGroup>
+
+<Callout type="tip">
+  Write documentation as if the reader is in a hurry. Get to the point quickly and make information easy to scan.
+</Callout>