@mgks/docmd 0.1.2 → 0.1.4

package/docs/overview.md

@@ -0,0 +1,56 @@
+---
+title: "Minimalist Markdown Docs Generator"
+description: "Generate beautiful, lightweight static documentation sites directly from your Markdown files with docmd. Zero clutter, just content."
+---
+
+# docmd
+
+**Generate beautiful, lightweight static documentation sites directly from your Markdown files. Zero clutter, just content.**
+
+`docmd` is a Node.js-based command-line tool that transforms a directory of Markdown files (`.md`) into a clean, fast, and themeable static website. It prioritizes simplicity for the author, leveraging standard Markdown and intuitive configuration, while producing elegant and functional documentation sites.
+
+::: callout tip
+This very documentation site is built using `docmd`!
+:::
+
+## Core Philosophy
+
+*   **Markdown First:** Your content lives in standard `.md` files with simple YAML frontmatter.
+*   **Minimal Configuration:** Sensible defaults with straightforward overrides via `config.js`.
+*   **Lightweight Build:** Fast generation process using Node.js, no complex framework dependencies for the build itself.
+*   **Beautiful Defaults:** Clean, responsive design with light/dark themes and syntax highlighting out-of-the-box.
+*   **Static Output:** Deploy the generated `site/` folder anywhere (GitHub Pages, Netlify, Vercel, etc.).
+
+## Key Features
+
+*   📝 **Standard Markdown & Frontmatter:** Write content naturally, define page metadata (title, description) easily.
+*   🎨 **Themeable:** Built-in light/dark modes, customizable via CSS variables. Uses `highlight.js` for code blocks.
+*   🧩 **Custom Containers:** Add richer components like callouts, cards, and steps using simple `::: name :::` syntax.
+*   ⚙️ **Config-Driven Navigation:** Define your site structure and sidebar navigation in `config.js`. Supports nested items.
+*   🚀 **Fast Static Build:** Node.js script quickly processes files into optimized HTML & CSS.
+*   💻 **Simple CLI:** Easy-to-use commands (`docmd build`, `docmd init`, `docmd dev`) with clear feedback.
+*   🌐 **Deploy Anywhere:** Generates a standard static `site/` directory.
+
+## Get Started Quickly
+
+1.  **Install `docmd`:**
+    ```bash
+    npm install -g @mgks/docmd
+    ```
+2.  **Initialize Your Project:**
+    ```bash
+    cd my-project-docs
+    docmd init
+    ```
+3.  **Write Your Content:**
+    Create `.md` files in the `docs/` directory.
+4.  **Preview Live:**
+    ```bash
+    docmd dev
+    ```
+5.  **Build for Production:**
+    ```bash
+    docmd build
+    ```
+
+Dive into the [Getting Started](/getting-started/installation/) guide for more details, or explore the sidebar to learn about specific features.

package/docs/plugins/sitemap.md

@@ -85,4 +85,4 @@ sitemap: false
 
 ## Verifying Your Sitemap
 
-After building your site, check the generated sitemap at `your-site/sitemap.xml`. You can also submit the sitemap URL to search engines like Google Search Console or Bing Webmaster Tools to help them discover and index your content more efficiently. 
+After building your site, check the generated sitemap at `your-site/sitemap.xml`. You can also submit the sitemap URL to search engines like Google Search Console or Bing Webmaster Tools to help them discover and index your content more efficiently.

package/docs/theming/assets-management.md

@@ -123,4 +123,4 @@ For more information on deployment, see the [Deployment](/deployment/) documenta
 ## Related Topics
 
 - [Custom CSS & JS](/theming/custom-css-js/) - Learn how to configure custom CSS and JavaScript
-- [Theming](/theming/) - Explore other theming options for your documentation site 
+- [Theming](/theming/) - Explore other theming options for your documentation site

package/docs/theming/available-themes.md

@@ -7,79 +7,57 @@ description: "An overview of the built-in themes provided by docmd."
 
 `docmd` allows you to choose from a selection of built-in themes to quickly change the overall look and feel of your documentation site. You can specify the theme in your `config.js` file using the `theme.name` property.
 
-## 1. `default` Theme
-
-*   **`theme.name: 'default'`** (This is the default if `theme.name` is not specified)
-*   **Description:** The standard `docmd` theme. It's designed to be clean, modern, responsive, and highly readable. It features:
-    *   A collapsible sidebar for navigation.
-    *   Support for light and dark color modes.
-    *   Clear typography optimized for documentation.
-    *   Well-styled custom containers (callouts, cards, steps).
-    *   Effective syntax highlighting for code blocks.
-*   **When to use:** A great general-purpose theme suitable for most documentation projects.
-
 ```javascript
 // config.js
 module.exports = {
   // ...
   theme: {
-    name: 'default',
-    defaultMode: 'light',
+    name: 'theme-name', // Options: 'default', 'sky', 'ruby'
+    defaultMode: 'light', // or 'dark'
     // ...
   },
   // ...
 };
 ```
 
+## 1. `default` Theme
+
+*   **`theme.name: 'default'`**
+*   **Description:** The foundation of all docmd themes. This is not a separate theme but the base styling that's always included regardless of which theme you select. It provides:
+    *   Basic layout structure with sidebar and content area
+    *   Essential typography and spacing
+    *   Core styling for documentation elements like code blocks, tables, and custom containers
+    *   Light and dark mode foundation
+*   **When to use:** When you want a minimalist, clean interface without additional styling layers. This is the most lightweight option.
+
 ## 2. `sky` Theme
 
-*   **`theme.name: 'sky'`**
+*   **`theme.name: 'sky'`** (This is the default if `theme.name` is not specified)
 *   **Description:** A modern theme inspired by popular documentation platforms, with a fresh and airy design. It features:
-    *   A clean, minimalist interface with subtle shadows and rounded corners.
-    *   Custom typography with improved readability.
-    *   Refined color palette for both light and dark modes.
-    *   Enhanced callout and container styles.
-    *   Premium documentation feel with careful attention to spacing and contrast.
+    *   A clean, minimalist interface with subtle shadows and rounded corners
+    *   Custom typography with improved readability
+    *   Refined color palette for both light and dark modes
+    *   Enhanced callout and container styles
+    *   Premium documentation feel with careful attention to spacing and contrast
 *   **When to use:** When you want a premium, polished look for your documentation site.
 
-```javascript
-// config.js
-module.exports = {
-  // ...
-  theme: {
-    name: 'sky',
-    defaultMode: 'light', // or 'dark'
-    // ...
-  },
-  // ...
-};
-```
-
-## Light and Dark Mode
-
-All themes support both light and dark color modes. You can set the default mode using the `theme.defaultMode` property and enable a toggle button with `theme.enableModeToggle`:
-
-```javascript
-// config.js
-module.exports = {
-  // ...
-  theme: {
-    name: 'sky', // or 'default'
-    defaultMode: 'dark', // Start in dark mode
-    enableModeToggle: true, // Show a toggle button in the sidebar
-    // ...
-  },
-  // ...
-};
-```
+## 3. `ruby` Theme
 
-Users can switch between modes using the toggle button in the sidebar, and their preference will be saved in localStorage for future visits.
+*   **`theme.name: 'ruby'`**
+*   **Description:** An elegant, vibrant theme inspired by the precious gemstone. It features:
+    *   Rich, jewel-toned color palette centered around ruby reds and complementary colors
+    *   Sophisticated typography with serif headings and sans-serif body text
+    *   Distinctive card and callout designs with gem-like faceted styling
+    *   Subtle gradients and depth effects that evoke the brilliance of gemstones
+    *   Luxurious dark mode with deep, rich backgrounds and vibrant accent colors
+*   **When to use:** When you want your documentation to have a distinctive, premium feel with rich colors and elegant typography.
 
 ## How Themes Work
 
 Each theme consists of CSS files located within `docmd`'s internal assets. When you select a theme name, `docmd` links the corresponding stylesheet in your site's HTML:
 
 - `default` theme uses the base CSS with no additional theme stylesheet
-- `sky` theme loads `theme-sky.css` with its custom styling
+- `sky` theme loads `docmd-theme-sky.css` with its custom styling on top of the default CSS
+- `ruby` theme loads `docmd-theme-ruby.css` with its custom styling on top of the default CSS
 
 You can further customize any chosen theme using the `theme.customCss` option in your `config.js` to add your own overrides or additional styles. See [Custom CSS & JS](/theming/custom-css-js/) for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mgks/docmd",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Generate beautiful, lightweight static documentation sites directly from your Markdown files. Zero clutter, just content.",
   "main": "src/index.js",
   "bin": {

package/src/assets/css/docmd-main.css

@@ -142,8 +142,9 @@
     flex-grow: 1;
     display: flex;
     flex-direction: column;
+    overflow: hidden;
   }
-  
+
   .page-header {
     padding: 15px 30px;
     border-bottom: 1px solid var(--header-border);