create-opendocs 0.1.0 → 0.1.1

package/README.md

@@ -2,22 +2,19 @@
 
 `create-opendocs` scaffolds a new OpenDocs-powered documentation site.
 
-## What It Creates
-
-The generated project is a Next.js docs app with:
+## Quick Start
 
-- File-based content in `content/`
-- Sidebar navigation configured in `content/config.json`
-- Markdown and MDX page support
-- A footer CTA block driven by config
-- Static page generation and sitemap support
+Create a new docs site with `npx`:
 
-## Usage
+```bash
+npx create-opendocs my-docs
+```
 
-Create a new project:
+Then run it locally:
 
 ```bash
-npx create-opendocs my-docs
+cd my-docs
+npm run dev
 ```
 
 Create a project with custom defaults:
@@ -26,12 +23,18 @@ Create a project with custom defaults:
 npx create-opendocs my-docs --site-name "My Docs" --support-email docs@example.com --site-url https://docs.example.com
 ```
 
-Then run:
+## What It Creates
 
-```bash
-cd my-docs
-npm run dev
-```
+The generated project is a Next.js docs app with:
+
+- File-based content in `content/`
+- Sidebar navigation configured in `content/config.json`
+- Markdown and MDX page support
+- Mermaid diagram support with fenced `mermaid` blocks
+- A footer CTA block driven by config
+- Static page generation and sitemap support
+
+The generated project includes starter docs content, sidebar configuration, and a working homepage out of the box.
 
 ## Options
 
@@ -42,6 +45,57 @@ npm run dev
 - `--no-install`: skip `npm install`
 - `--force`: allow copying into a non-empty directory
 
+## Generated Project
+
+After scaffolding, the generated app is a normal Next.js project. The main files you’ll edit are:
+
+- `content/config.json`: homepage, sidebar, and footer settings
+- `content/`: Markdown and MDX docs content
+- `src/app/`: app shell and page routes
+- `src/lib/docs.ts`: docs loading and sidebar generation
+
+## Editing Config After Creation
+
+After the project is created, you can update the docs structure in `content/config.json`.
+
+Example:
+
+```json
+{
+  "homepage": "index.md",
+  "sidebar": [
+    {
+      "title": "Getting Started",
+      "items": [
+        "index.md",
+        "guides/getting-started.md"
+      ]
+    },
+    {
+      "title": "Reference",
+      "items": [
+        "api/authentication.md",
+        "api/webhooks.mdx"
+      ]
+    }
+  ],
+  "contactSupport": {
+    "title": "Need help?",
+    "description": "Contact the docs team if anything is unclear.",
+    "buttonText": "Email us",
+    "buttonLink": "mailto:docs@example.com"
+  }
+}
+```
+
+What you can change:
+
+- `homepage`: which file renders at `/`
+- `sidebar`: the navigation groups and page order
+- `contactSupport`: the footer title, text, button label, and link
+
+To add a page to the nav, create a matching file in `content/` and then add its path to `sidebar.items`.
+
 ## Repository Layout
 
 - `src/create-opendocs.js`: the CLI entrypoint

package/package.json

@@ -1,9 +1,18 @@
 {
   "name": "create-opendocs",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Scaffold a new OpenDocs documentation site.",
+  "author": "Alex Connolly",
   "license": "MIT",
   "preferGlobal": true,
+  "homepage": "https://github.com/AlexConnolly/OpenDocs#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AlexConnolly/OpenDocs.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AlexConnolly/OpenDocs/issues"
+  },
   "bin": {
     "create-opendocs": "./src/create-opendocs.js"
   },

package/template/README.md

@@ -29,6 +29,7 @@ $env:NEXT_PUBLIC_SITE_URL="__SITE_URL__"
 - Loads docs from the `content/` folder
 - Builds the sidebar from `content/config.json`
 - Renders Markdown and MDX pages automatically from file paths
+- Supports Mermaid diagrams via fenced `mermaid` code blocks
 - Shows an optional footer CTA from config
 - Generates a sitemap from your docs pages
 

package/template/content/guides/getting-started.md

@@ -19,3 +19,13 @@ Open `http://localhost:3000` to view your docs site.
 ## Add Pages
 
 Create Markdown or MDX files in `content/`, then list them in `content/config.json` if you want them to appear in the sidebar.
+
+## Mermaid Diagrams
+
+Mermaid code fences render automatically:
+
+```mermaid
+flowchart TD
+    A[Write docs] --> B[Commit changes]
+    B --> C[Deploy site]
+```