@mgks/docmd 0.3.2 → 0.3.3

package/README.md

@@ -159,4 +159,8 @@ This project is open source and free to use. If you find it valuable, please con
 
 ## 📄 License
 
-Distributed under the MIT License. See `LICENSE` for more information.
+Distributed under the MIT License. See `LICENSE` for more information.
+
+> **{ github.com/mgks }**
+> 
+> ![Website Badge](https://img.shields.io/badge/Visit-mgks.dev-blue?style=flat&link=https%3A%2F%2Fmgks.dev) ![Sponsor Badge](https://img.shields.io/badge/%20%20Become%20a%20Sponsor%20%20-red?style=flat&logo=github&link=https%3A%2F%2Fgithub.com%2Fsponsors%2Fmgks)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mgks/docmd",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Generate beautiful, lightweight static documentation sites directly from your Markdown files. Zero clutter, just content.",
   "main": "src/index.js",
   "exports": {
@@ -18,29 +18,8 @@
     "postinstall": "node ./bin/postinstall.js",
     "lint": "eslint .",
     "format": "prettier --write .",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"No tests specified currently\" && exit 0"
   },
-  "engines": {
-    "node": ">=22.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/mgks/docmd.git"
-  },
-  "keywords": [
-    "markdown",
-    "static-site-generator",
-    "documentation",
-    "ssg",
-    "docs",
-    "generator"
-  ],
-  "author": "Ghazi <hello@mgks.dev>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/mgks/docmd/issues"
-  },
-  "homepage": "https://github.com/mgks/docmd#readme",
   "dependencies": {
     "chalk": "^4.1.2",
     "chokidar": "^4.0.3",
@@ -72,5 +51,30 @@
   },
   "directories": {
     "doc": "docs"
-  }
+  },
+  "keywords": [
+    "markdown",
+    "static-site-generator",
+    "documentation",
+    "ssg",
+    "docs",
+    "generator"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "author": {
+    "name": "Ghazi",
+    "url": "https://mgks.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mgks/docmd.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mgks/docmd/issues"
+  },
+  "homepage": "https://github.com/mgks/docmd#readme",
+  "funding": "https://github.com/sponsors/mgks",
+  "license": "MIT"
 }

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/.github/CODE_OF_CONDUCT.md

@@ -1,48 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at hello@mgks.dev.
-All complaints will be reviewed and investigated promptly and fairly.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

package/.github/CONTRIBUTING.md

@@ -1,129 +0,0 @@
-# Contributing to docmd
-
-First off, thank you for considering contributing to `docmd`! It's people like you that make the open-source community such an amazing place to learn, inspire, and create.
-
-We welcome contributions of all kinds: bug fixes, new features, documentation improvements, or even just typo fixes.
-
-## ⚡ Quick Links
-
-*   [**Documentation**](https://docmd.mgks.dev) - Read the docs to understand how the tool works.
-*   [**GitHub Issues**](https://github.com/mgks/docmd/issues) - Browse existing bugs or feature requests.
-*   [**Discussions**](https://github.com/mgks/docmd/discussions) - Ask questions or share ideas.
-
----
-
-## 🛠️ Development Setup
-
-`docmd` is a Node.js CLI tool. Developing it locally requires a slightly different setup than a standard web app.
-
-### Prerequisites
-*   **Node.js**: Version 22.x or higher.
-*   **npm**: Version 10.x or higher.
-
-### 1. Fork and Clone
-1.  Fork the repository to your GitHub account.
-2.  Clone your fork locally:
-    ```bash
-    git clone https://github.com/YOUR_USERNAME/docmd.git
-    cd docmd
-    ```
-
-### 2. Install Dependencies
-```bash
-npm install
-```
-
-### 3. Link for Local Development
-To test the CLI command (`docmd`) globally on your machine while modifying the source code, use `npm link`.
-
-```bash
-# inside the project root
-npm link
-```
-
-Now, when you run `docmd` in *any* terminal window, it will use the code from your local folder.
-
-### 4. Running the Dev Server
-We have a built-in test site located in the `docs/` folder (this is the documentation for docmd itself).
-
-To start the dev server and watch for changes:
-
-```bash
-# Method 1: Using the npm script (Recommended)
-npm start
-
-# Method 2: If you have linked the package
-docmd dev
-```
-
-### 5. Developer Mode (Important)
-By default, `docmd` only watches the user's content files. To make `docmd` watch **its own internal source code** (templates, css, core logic) and trigger a rebuild when you edit them, set the environment variable:
-
-```bash
-# Mac/Linux
-export DOCMD_DEV=true
-npm start
-
-# Windows (PowerShell)
-$env:DOCMD_DEV="true"
-npm start
-```
-
----
-
-## 📂 Project Structure
-
-Here is a map of the codebase to help you navigate:
-
-```text
-bin/
-  └── docmd.js          # The CLI entry point
-src/
-  ├── commands/         # Logic for 'init', 'build', 'dev'
-  ├── core/
-  │   ├── config-loader.js   # Loads docmd.config.js
-  │   ├── config-validator.js # Validates config structure
-  │   ├── file-processor.js  # Orchestrates file reading
-  │   ├── html-generator.js  # Injects content into EJS templates
-  │   └── markdown/          # The Core Parsing Engine
-  │       ├── containers.js  # Callout/Card definitions
-  │       ├── rules.js       # Complex logic (Tabs, Changelogs)
-  │       └── setup.js       # MarkdownIt configuration
-  ├── plugins/          # Built-in plugins (SEO, Sitemap)
-  ├── templates/        # EJS HTML templates
-  └── assets/           # Internal CSS and JS (Themes)
-docs/                   # The documentation site content
-site/                   # The generated output folder (gitignored)
-```
-
----
-
-## 🚀 Submitting a Pull Request
-
-1.  **Create a Branch:** Always create a new branch for your changes.
-    *   `feat/my-new-feature`
-    *   `fix/bug-description`
-    *   `docs/update-readme`
-2.  **Make Changes:** Write clear, concise code.
-3.  **Test:**
-    *   Run `docmd build` to ensure the build process finishes without errors.
-    *   Verify your changes visually by running `docmd dev`.
-4.  **Commit:** We prefer [Conventional Commits](https://www.conventionalcommits.org/).
-    *   `feat: add search bar`
-    *   `fix: resolve css overflow in tables`
-    *   `docs: fix typo in readme`
-5.  **Push & Open PR:** Push your branch to your fork and open a Pull Request against the `main` branch of `mgks/docmd`.
-
----
-
-## 🎨 Style Guidelines
-
-*   **Linting:** Please ensure your code follows the existing style. (We use standard ESLint/Prettier configurations).
-*   **No-Style:** If modifying `no-style` templates, ensure no external CSS is injected unless requested.
-*   **Compatibility:** `docmd` aims to be lightweight. Avoid adding heavy dependencies unless absolutely necessary.
-
----
-
-## 🤝 Community
-
-Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.

package/.github/FUNDING.yml

@@ -1,15 +0,0 @@
-# These are supported funding model platforms
-
-github: mgks # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-polar: # Replace with a single Polar username
-buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
-thanks_dev: # Replace with a single thanks.dev username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,58 +0,0 @@
-name: 🐞 Bug Report
-description: Create a report to help us improve docmd
-title: "[Bug]: "
-labels: ["bug", "triage"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for taking the time to fill out this bug report!
-  - type: input
-    id: version
-    attributes:
-      label: docmd version
-      description: What version of docmd are you using? (e.g. 0.2.6)
-      placeholder: 0.2.6
-    validations:
-      required: true
-  - type: input
-    id: node-version
-    attributes:
-      label: Node.js version
-      placeholder: v20.x
-    validations:
-      required: true
-  - type: dropdown
-    id: os
-    attributes:
-      label: OS/Browser
-      options:
-        - macOS / Safari
-        - Windows / Edge
-        - Linux / Chrome
-    validations:
-      required: true
-  - type: textarea
-    id: description
-    attributes:
-      label: Description
-      description: A clear and concise description of what the bug is.
-    validations:
-      required: true
-  - type: textarea
-    id: reproduction
-    attributes:
-      label: Steps to Reproduce
-      description: Please provide the steps to reproduce the behavior.
-      placeholder: |
-        1. Run 'docmd init'
-        2. Add configuration...
-        3. Run 'docmd build'
-        4. See error...
-    validations:
-      required: true
-  - type: textarea
-    id: expected
-    attributes:
-      label: Expected Behavior
-      description: A clear and concise description of what you expected to happen.

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,27 +0,0 @@
-name: 💡 Feature Request
-description: Suggest an idea for this project
-title: "[Feature]: "
-labels: ["enhancement"]
-body:
-  - type: markdown
-    attributes:
-      value: |
-        Thanks for suggesting a new feature!
-  - type: textarea
-    id: problem
-    attributes:
-      label: Is your feature request related to a problem?
-      description: A clear and concise description of what the problem is.
-      placeholder: I'm always frustrated when...
-  - type: textarea
-    id: solution
-    attributes:
-      label: Describe the solution you'd like
-      description: A clear and concise description of what you want to happen.
-    validations:
-      required: true
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Describe alternatives you've considered
-      description: A clear and concise description of any alternative solutions or features you've considered.

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,16 +0,0 @@
-## Description
-<!-- Please include a summary of the change and which issue is fixed. -->
-
-Fixes # (issue)
-
-## Type of change
-- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
-- [ ] ✨ New feature (non-breaking change which adds functionality)
-- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] 📝 Documentation update
-
-## Checklist:
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] My changes generate no new warnings

package/.github/SECURITY.md

@@ -1,18 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 0.2.x   | :white_check_mark: |
-| 0.1.x   | :x:                |
-
-## Reporting a Vulnerability
-
-Use this section to tell people how to report a vulnerability.
-
-Please do not report security vulnerabilities through public GitHub issues.
-
-If you have discovered a security vulnerability in `docmd`, please email hello@mgks.dev.
-
-We will do our best to respond within 48 hours.

package/.github/workflows/deploy-docmd.yml

@@ -1,45 +0,0 @@
-name: deploy docmd
-
-on:
-  push:
-    branches: [main] # Your default branch
-  workflow_dispatch: # Allows manual triggering
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-jobs:
-  build-and-deploy:
-    runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Checkout 🛎️
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js ⚙️
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          cache: 'npm'
-
-      - name: Install Dependencies 📦
-        run: npm ci
-
-      - name: Build docmd's Own Docs 🛠️
-        run: node ./bin/docmd.js build
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: ./site
-
-      - name: Deploy to GitHub Pages 🚀
-        id: deployment
-        uses: actions/deploy-pages@v4

package/.github/workflows/npm-publish.yml

@@ -1,49 +0,0 @@
-name: Publish Package to NPM and GitHub Packages
-
-on:
-  release:
-    types: [published]
-  workflow_dispatch:
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js v22
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-          cache: 'npm'
-
-      - name: Install dependencies
-        run: npm ci
-
-      # ------------------------------------------
-      # --- Publish to NPM Registry (npmjs.com) ---
-      # ------------------------------------------
-      - name: Configure NPM for public registry
-        run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
-
-      - name: Publish to NPM Registry
-        run: npm publish --access=public
-        # env:
-        #  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-      # ----------------------------------------
-      # --- Publish to GitHub Packages (GPR) ---
-      # ----------------------------------------
-      - name: Configure NPM for GitHub Packages registry
-        run: |
-          echo "@mgks:registry=https://npm.pkg.github.com" > ~/.npmrc
-          echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" >> ~/.npmrc
-
-      - name: Publish to GitHub Packages
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/assets/css/welcome.css

@@ -1,6 +0,0 @@
-/*
- * Source file from the docmd project — https://github.com/mgks/docmd
- * Welcome page stylesheet for the docmd project's own documentation
- */
-
-:root,html[data-theme=light]{--primary-color:#047bf1;--primary-hover:#026ed9;--text-color:#333;--text-light:#666;--bg-color:#fff;--bg-secondary:#f8f9fa;--border-color:#eaeaea}.theme-toggle,body{color:var(--text-color);display:flex}.logo-text,h1{font-weight:700}.install-code pre,.logo-text{font-family:'PT Mono',monospace}:root{--shadow-color:#00000014;--container-padding:5rem}@media (prefers-color-scheme:dark){:root{--primary-color:#047bf1;--primary-hover:#026ed9;--text-color:#e0e0e0;--text-light:#aaa;--bg-color:#121212;--bg-secondary:#1e1e1e;--border-color:#333;--shadow-color:#0000004d}}[data-theme=light]{--shadow-color:#00000059}[data-theme=dark]{--primary-color:#1955b6;--primary-hover:#084dbd;--text-color:#e0e0e0;--text-light:#aaa;--bg-color:#121212;--bg-secondary:#1e1e1e;--border-color:#333;--shadow-color:#000000de}*{margin:0;padding:0;box-sizing:border-box}body{font-family:Inter,-apple-system,BlinkMacSystemFont,sans-serif;line-height:1.5;background-color:var(--bg-color);height:100vh;overflow:hidden}.landing-container{display:flex;width:100%;height:100%;padding:0 var(--container-padding);max-width:1600px;margin:0 auto}.content-side{flex:1;padding:3rem 2rem 3rem 0;display:flex;flex-direction:column;justify-content:center}.preview-side{flex:1;display:flex;align-items:center;justify-content:flex-start;position:relative;overflow:visible}.header-top{position:absolute;top:2rem;right:3rem;z-index:100}.theme-toggle{background:var(--bg-secondary);border:1px solid var(--border-color);width:40px;height:40px;border-radius:50%;align-items:center;justify-content:center;cursor:pointer;transition:.2s}.theme-toggle:hover{background:var(--border-color)}.logo{margin-bottom:1.5rem;display:flex;align-items:center}.buttons,.features,.install-section,.tagline{margin-bottom:2rem}.logo svg{height:48px;width:auto}.logo-text{font-size:2em;margin-left:.25em}h1{font-size:3rem;margin-bottom:1rem;letter-spacing:-.02em}.tagline{font-size:1.25rem;color:var(--text-light);font-weight:400}.btn-primary,.feature-icon{background-color:var(--primary-color);color:#fff}.features{display:grid;grid-template-columns:repeat(2,1fr);gap:1.5rem}.feature{display:flex;align-items:flex-start;gap:.75rem}.feature-icon{width:32px;height:32px;border-radius:6px;display:flex;align-items:center;justify-content:center;flex-shrink:0}.feature-text{font-size:.9rem}.feature-text strong{display:block;margin-bottom:.25rem}.buttons{display:flex;gap:1rem}.btn{display:inline-flex;align-items:center;gap:.5rem;padding:.75rem 1.5rem;border-radius:8px;font-weight:600;font-size:1rem;text-decoration:none;transition:.2s}.btn-primary{border:none}.btn-secondary,.install-code pre{background-color:var(--bg-secondary);border:1px solid var(--border-color)}.btn-primary:hover{background-color:var(--primary-hover)}.btn-secondary{color:var(--text-color)}.btn-secondary:hover{background-color:var(--border-color)}.social-links{display:flex;gap:1rem;padding:0 .25em}.social-link{color:var(--text-light);transition:color .2s}.social-link:hover{color:var(--primary-color)}.preview-stack{position:relative;width:100%;height:400px;transform:translateX(15%);perspective:1000px}.preview-image{position:absolute;width:100%;max-width:700px;height:400px;border-radius:20px;box-shadow:0 25px 50px -12px var(--shadow-color);transition:.3s;overflow:hidden}.preview-image img{width:100%;height:100%;object-fit:cover;object-position:left top;border-radius:8px;pointer-events:none}.preview-image.top{z-index:3;transform:rotate(3deg) translateY(-10%) translateX(7%)}.preview-image.middle{z-index:2;transform:rotate(-3deg) translateY(1%) translateX(-2%)}.preview-image.bottom{z-index:1;transform:rotate(-8deg) translateY(10%) translateX(-10%)}[data-theme=dark] .preview-image .dark-img,[data-theme=light] .preview-image .light-img{display:block}[data-theme=dark] .preview-image .light-img,[data-theme=light] .preview-image .dark-img{display:none}@media (max-width:1400px){:root{--container-padding:3rem}.preview-stack{transform:translateX(15%)}}@media (max-width:1200px){:root{--container-padding:2rem}.preview-side{display:none}.content-side{max-width:100%;padding:3rem 0}.header-top{right:2rem}}@media (max-width:768px){:root{--container-padding:1.5rem}body{overflow:auto}.content-side{padding:2rem 0}.features{grid-template-columns:1fr}.buttons{flex-direction:column}.header-top{padding:1rem 0;text-align:center;right:1rem}h1{font-size:2.5rem}.tagline{font-size:1em;font-weight:500}.landing-container{padding:1rem;flex-direction:column}}.social-links .lucide-heart-handshake{color:#cd2727}.install-code{position:relative;display:inline-block}.install-code pre{border-radius:8px;padding:1rem 3.5rem 1rem 1rem;margin:0;font-size:.9rem;color:var(--text-color)}.install-code code{background:0 0;padding:0;color:inherit}.copy-button{position:absolute;top:.5rem;right:.5rem;background:var(--bg-color);border:1px solid var(--border-color);border-radius:4px;padding:.5rem;cursor:pointer;transition:.2s;color:var(--text-light)}.copy-button:hover{background:var(--border-color);color:var(--text-color)}

package/docs/cli-commands.md

@@ -1,108 +0,0 @@
----
-title: "CLI Commands"
-description: "A reference guide to all available docmd command-line interface (CLI) commands and their options."
----
-
-# CLI Commands
-
-`docmd` provides a set of commands to help you initialize, build, and preview your documentation site.
-
-## `docmd init`
-
-Initializes a new `docmd` project in the current directory.
-
-**Usage:**
-```bash
-docmd init
-```
-
-**Description:**
-This command creates the basic file and directory structure required for a `docmd` project:
-*   `docs/`: A directory to store your Markdown source files.
-    *   `docs/index.md`: A sample Markdown file.
-*   `docmd.config.js`: The main configuration file for your site, pre-filled with default settings.
-
-If a `docs/` directory or `docmd.config.js` file already exists, `docmd init` will typically warn you and avoid overwriting them to prevent accidental data loss.
-
-**Options:**
-This command currently does not take any options.
-
-## `docmd build`
-
-Builds your static documentation site.
-
-**Usage:**
-```bash
-docmd build [options]
-```
-
-**Description:**
-The `build` command reads your Markdown files from the source directory (specified by `srcDir` in `docmd.config.js`, defaults to `docs/`), processes them along with your `docmd.config.js`, and generates a complete static website in the output directory (specified by `outputDir` in `docmd.config.js`, defaults to `site/`).
-
-The output `site/` directory contains all the HTML, CSS, JavaScript, and other assets needed to deploy your documentation.
-
-By default, the build process will update all assets to ensure you have the latest versions from the docmd package. This ensures your site benefits from the latest improvements and fixes.
-
-**Options:**
-
-*   `-c, --config <path>`
-    *   **Default:** `docmd.config.js` or `config.js`
-    *   **Description:** Specifies the path to the configuration file.
-
-*   `-p, --preserve`
-    *   **Default:** `false`
-    *   **Description:** Preserves existing asset files instead of updating them.
-
-*   `--silent`
-    *   **Default:** `false`
-    *   **Description:** Suppresses most log output in the console. Useful for running in automated environments.
-
-## `docmd dev`
-
-Starts a local development server with live reloading.
-
-**Usage:**
-```bash
-docmd dev [options]
-```
-
-**Description:**
-The `dev` command is essential for writing and previewing your documentation. It:
-1.  Performs an initial build of your site.
-2.  Starts a local web server (usually on `http://localhost:3000`).
-3.  Watches your source files (`docs/` directory, `docmd.config.js`, and internal `docmd` theme assets) for changes.
-4.  When a change is detected, it automatically rebuilds the necessary parts of your site and triggers a live reload in your browser.
-
-This provides a fast feedback loop, allowing you to see your changes almost instantly.
-
-**Options:**
-
-*   `-c, --config <path>`
-    *   **Default:** `docmd.config.js` or `config.js`
-    *   **Description:** Specifies the path to the configuration file.
-
-*   `--port <number>`
-    *   **Default:** `3000`
-    *   **Description:** Specifies the port for the development server. If the port is in use, docmd will automatically try the next available one.
-    *   **Example:** `docmd dev --port 8080`
-
-*   `-p, --preserve`
-    *   **Default:** `false`
-    *   **Description:** Preserves existing asset files instead of updating them.
-
-*   `--silent`
-    *   **Default:** `false`
-    *   **Description:** Suppresses most log output in the console. Useful for running in automated environments.
-
-**Note:** The development server starts on port 3000 by default. If port 3000 is already in use, the server will automatically try the next available port (3001, 3002, etc.) until it finds an open port.
-
-## Global Options (Apply to all commands)
-
-*   `--version`
-    *   **Usage:** `docmd --version`
-    *   **Description:** Displays the installed version of `docmd`.
-*   `--help`
-    *   **Usage:** `docmd --help` or `docmd <command> --help` (e.g., `docmd build --help`)
-    *   **Description:** Displays help information for `docmd` or a specific command, including available options.
-
-This reference should help you effectively use `docmd` from your command line. For more detailed explanations of how these commands fit into the workflow, see the [Getting Started > Basic Usage](/getting-started/basic-usage/) guide.