@brainfish-ai/devdoc 0.1.21

package/templates/basic/docs.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://devdoc.sh/docs.json",
+  "name": "My Documentation",
+  "favicon": "/favicon.svg",
+  "logo": {
+    "light": "/logo.svg",
+    "dark": "/logo.svg"
+  },
+  "colors": {
+    "primary": "#10b981"
+  },
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Documentation",
+        "type": "docs",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "icon": "rocket-launch",
+            "pages": [
+              "index",
+              "quickstart"
+            ]
+          },
+          {
+            "group": "Guides",
+            "icon": "book-open",
+            "pages": [
+              "guides/overview",
+              "guides/configuration"
+            ]
+          }
+        ]
+      }
+    ],
+    "global": {
+      "anchors": [
+        {
+          "anchor": "GitHub",
+          "href": "https://github.com/your-org/your-repo",
+          "icon": "github-logo"
+        }
+      ]
+    }
+  }
+}

package/templates/basic/guides/configuration.mdx

@@ -0,0 +1,149 @@
+---
+title: Configuration
+description: Learn how to configure your documentation site
+---
+
+# Configuration
+
+Your documentation is configured through the `docs.json` file in the root of your project.
+
+## Basic Configuration
+
+```json title="docs.json"
+{
+  "name": "My Documentation",
+  "favicon": "/favicon.svg",
+  "logo": {
+    "light": "/logo.svg",
+    "dark": "/logo-dark.svg"
+  },
+  "colors": {
+    "primary": "#10b981"
+  }
+}
+```
+
+### Properties
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `name` | string | The name of your documentation site |
+| `favicon` | string | Path to favicon file |
+| `logo` | object/string | Logo configuration |
+| `colors` | object | Color customization |
+
+## Navigation
+
+Configure your sidebar navigation with tabs and groups:
+
+```json title="docs.json"
+{
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Documentation",
+        "type": "docs",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "icon": "rocket-launch",
+            "pages": ["index", "quickstart"]
+          },
+          {
+            "group": "Guides",
+            "pages": ["guides/overview", "guides/configuration"]
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+### Tab Types
+
+| Type | Description |
+|------|-------------|
+| `docs` | Standard documentation pages |
+| `openapi` | API reference from OpenAPI spec |
+| `changelog` | Changelog/release notes |
+
+## Nested Navigation
+
+You can create nested groups for complex documentation:
+
+```json
+{
+  "group": "Advanced",
+  "pages": [
+    "advanced/intro",
+    {
+      "group": "Subgroup",
+      "pages": ["advanced/sub/page1", "advanced/sub/page2"]
+    }
+  ]
+}
+```
+
+## Global Anchors
+
+Add external links to your navigation:
+
+```json
+{
+  "navigation": {
+    "global": {
+      "anchors": [
+        {
+          "anchor": "GitHub",
+          "href": "https://github.com/your-org/your-repo",
+          "icon": "github-logo"
+        },
+        {
+          "anchor": "Discord",
+          "href": "https://discord.gg/your-server",
+          "icon": "discord-logo"
+        }
+      ]
+    }
+  }
+}
+```
+
+## Notice Banner
+
+Display a site-wide notice:
+
+```json
+{
+  "notice": {
+    "content": "🚀 Check out [what's new](/changelog)!",
+    "dismissible": true,
+    "background": "#1e293b"
+  }
+}
+```
+
+## Redirects
+
+Set up URL redirects:
+
+```json
+{
+  "redirects": [
+    {
+      "source": "/old-page",
+      "destination": "/new-page"
+    }
+  ]
+}
+```
+
+## Environment Variables
+
+For sensitive configuration, use environment variables:
+
+| Variable | Description |
+|----------|-------------|
+| `STARTER_PATH` | Override content directory path |
+| `PORT` | Server port (default: 3000) |

package/templates/basic/guides/overview.mdx

@@ -0,0 +1,96 @@
+---
+title: Overview
+description: Learn the core concepts of your documentation
+---
+
+# Overview
+
+This guide covers the core concepts you need to know to build great documentation.
+
+## Writing Content
+
+All documentation is written in **MDX** - Markdown with JSX support. This means you can use standard Markdown syntax plus custom React components.
+
+### Markdown Basics
+
+```markdown
+# Heading 1
+## Heading 2
+### Heading 3
+
+**Bold text** and *italic text*
+
+- Bullet point
+- Another point
+
+1. Numbered list
+2. Second item
+
+[Link text](https://example.com)
+
+`inline code`
+```
+
+### Code Blocks
+
+Use fenced code blocks with language highlighting:
+
+```javascript title="example.js"
+function greet(name) {
+  console.log(`Hello, ${name}!`);
+}
+
+greet('World');
+```
+
+## Components
+
+DevDoc provides built-in components to enhance your documentation.
+
+### Notes and Callouts
+
+<Note>
+  This is a note for important information.
+</Note>
+
+<Warning>
+  This is a warning for critical information.
+</Warning>
+
+<Tip>
+  This is a tip for helpful suggestions.
+</Tip>
+
+### Cards
+
+<CardGroup cols={2}>
+  <Card title="Card Title" href="#">
+    Card description goes here.
+  </Card>
+  <Card title="Another Card" href="#">
+    Another description here.
+  </Card>
+</CardGroup>
+
+### Steps
+
+<Steps>
+  <Step title="First Step">
+    Description of the first step.
+  </Step>
+  <Step title="Second Step">
+    Description of the second step.
+  </Step>
+</Steps>
+
+### Accordion
+
+<Accordion title="Click to expand">
+  Hidden content that can be revealed by clicking.
+</Accordion>
+
+## Next Steps
+
+<Card title="Configuration" href="/guides/configuration">
+  Learn how to customize your documentation site.
+</Card>

package/templates/basic/index.mdx

@@ -0,0 +1,39 @@
+---
+title: Welcome
+description: Welcome to your documentation
+---
+
+# Welcome to Your Documentation
+
+This is your documentation homepage. Edit this file at `index.mdx` to customize it.
+
+## Getting Started
+
+<CardGroup cols={2}>
+  <Card title="Quickstart" href="/quickstart">
+    Get up and running in minutes
+  </Card>
+  <Card title="Guides" href="/guides/overview">
+    Learn the core concepts
+  </Card>
+</CardGroup>
+
+## Features
+
+<Steps>
+  <Step title="Write in MDX">
+    Use Markdown with React components for rich documentation
+  </Step>
+  <Step title="Preview Locally">
+    Run `npm run dev` to see changes instantly
+  </Step>
+  <Step title="Deploy">
+    Push to GitHub and deploy automatically with Vercel
+  </Step>
+</Steps>
+
+## Need Help?
+
+<Note>
+  Check out our [guides](/guides/overview) for detailed documentation on all features.
+</Note>

package/templates/basic/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "my-docs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "devdoc dev",
+    "build": "devdoc build",
+    "start": "devdoc start",
+    "check": "devdoc check"
+  },
+  "dependencies": {
+    "@brainfish-ai/devdoc": "latest"
+  }
+}

package/templates/basic/quickstart.mdx

@@ -0,0 +1,92 @@
+---
+title: Quickstart
+description: Get up and running with your documentation in minutes
+---
+
+# Quickstart
+
+Get your documentation site up and running in just a few minutes.
+
+## Prerequisites
+
+Make sure you have the following installed:
+
+- [Node.js](https://nodejs.org/) 18.0 or later
+- npm or yarn
+
+## Installation
+
+<Steps>
+  <Step title="Clone the template">
+    ```bash
+    git clone https://github.com/your-org/your-docs.git
+    cd your-docs
+    ```
+  </Step>
+  
+  <Step title="Install dependencies">
+    ```bash
+    npm install
+    ```
+  </Step>
+  
+  <Step title="Start the development server">
+    ```bash
+    npm run dev
+    ```
+    
+    Open [http://localhost:3000](http://localhost:3000) in your browser.
+  </Step>
+</Steps>
+
+## Project Structure
+
+```
+your-docs/
+├── docs.json          # Configuration file
+├── index.mdx          # Homepage
+├── quickstart.mdx     # This page
+├── guides/            # Guide pages
+│   ├── overview.mdx
+│   └── configuration.mdx
+├── public/            # Static assets
+│   ├── logo.svg
+│   └── favicon.svg
+└── package.json
+```
+
+## Configuration
+
+Edit `docs.json` to customize your documentation:
+
+```json
+{
+  "name": "My Documentation",
+  "logo": "/logo.svg",
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Documentation",
+        "type": "docs",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "pages": ["index", "quickstart"]
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+## Next Steps
+
+<CardGroup cols={2}>
+  <Card title="Configuration Guide" href="/guides/configuration">
+    Learn how to customize your docs
+  </Card>
+  <Card title="Overview" href="/guides/overview">
+    Understand the core concepts
+  </Card>
+</CardGroup>

package/templates/basic/vercel.json

@@ -0,0 +1,6 @@
+{
+  "buildCommand": "npm run build",
+  "outputDirectory": "dist",
+  "installCommand": "npm install",
+  "framework": null
+}

package/templates/graphql/README.md

@@ -0,0 +1,139 @@
+# My Documentation
+
+Documentation site built with [DevDoc](https://github.com/brainfish-ai/devdoc).
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/brainfish-ai/devdoc-starter)
+
+## Quick Start
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/) 18.0 or later
+- npm, yarn, or pnpm
+
+### Installation
+
+1. **Clone this repository**
+
+   ```bash
+   git clone https://github.com/your-username/your-docs.git
+   cd your-docs
+   ```
+
+   Or use the GitHub template button above.
+
+2. **Install dependencies**
+
+   ```bash
+   npm install
+   ```
+
+3. **Start the development server**
+
+   ```bash
+   npm run dev
+   ```
+
+4. **Open your browser**
+
+   Visit [http://localhost:3000](http://localhost:3000) to see your docs.
+
+## Project Structure
+
+```
+.
+├── docs.json              # Site configuration
+├── index.mdx              # Homepage
+├── quickstart.mdx         # Quickstart guide
+├── guides/
+│   ├── overview.mdx       # Overview page
+│   └── configuration.mdx  # Configuration guide
+├── public/
+│   ├── logo.svg           # Site logo
+│   └── favicon.svg        # Favicon
+├── package.json
+├── vercel.json            # Vercel deployment config
+└── README.md
+```
+
+## Configuration
+
+Edit `docs.json` to customize your site:
+
+```json
+{
+  "name": "My Documentation",
+  "logo": "/logo.svg",
+  "navigation": {
+    "tabs": [
+      {
+        "tab": "Documentation",
+        "type": "docs",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "pages": ["index", "quickstart"]
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+## Writing Content
+
+Create `.mdx` files with frontmatter:
+
+```mdx
+---
+title: Page Title
+description: Page description for SEO
+---
+
+# Your Content Here
+
+Write Markdown with React components.
+
+<Note>
+  Use components like Note, Card, Steps, and more.
+</Note>
+```
+
+## Available Commands
+
+| Command | Description |
+|---------|-------------|
+| `npm run dev` | Start development server |
+| `npm run build` | Build for production |
+| `npm run start` | Start production server |
+| `npm run check` | Validate configuration |
+
+## Deployment
+
+### Vercel (Recommended)
+
+Click the "Deploy with Vercel" button above, or:
+
+1. Push your code to GitHub
+2. Import the repository in [Vercel](https://vercel.com)
+3. Deploy!
+
+### Other Platforms
+
+```bash
+# Build the site
+npm run build
+
+# Output is in the dist/ directory
+```
+
+## Learn More
+
+- [DevDoc Documentation](https://devdoc.sh/docs)
+- [MDX Documentation](https://mdxjs.com/)
+- [Vercel Documentation](https://vercel.com/docs)
+
+## License
+
+MIT