@mgks/docmd 0.2.8 → 0.2.9

package/config.js

@@ -19,6 +19,7 @@ module.exports = {
   // Directory Configuration
   srcDir: 'docs',       // Source directory for Markdown files
   outputDir: 'site',    // Directory for generated static site
+  minify: true,         // Enable/disable HTML/CSS/JS minification
 
   // Sidebar Configuration
   sidebar: {
@@ -88,6 +89,15 @@ module.exports = {
     // Add other future plugin configurations here by their key
   },
 
+  // "Edit this page" Link Configuration
+  editLink: {
+    enabled: true,
+    // The URL to the folder containing your docs in the git repo
+    // Note: It usually ends with /edit/main/docs or /blob/main/docs
+    baseUrl: 'https://github.com/mgks/docmd/edit/main/docs',
+    text: 'Edit this page on GitHub'
+  },
+
   // Navigation Structure (Sidebar)
   // Icons are kebab-case names from Lucide Icons (https://lucide.dev/)
   navigation: [
@@ -103,6 +113,7 @@ module.exports = {
           { title: 'Basic Usage', path: '/getting-started/basic-usage', icon: 'play' },
         ],
       },
+      { title: 'Configuration', path: '/configuration', icon: 'settings' },
       {
         title: 'Content',
         icon: 'layout-template',
@@ -133,7 +144,6 @@ module.exports = {
           { title: 'No-Style Example', path: '/content/no-style-example', icon: 'sparkles' },
         ],
       },
-      { title: 'Configuration', path: '/configuration', icon: 'settings' },
       {
         title: 'Theming',
         icon: 'palette',

package/docs/configuration.md

@@ -125,6 +125,14 @@ module.exports = {
 *   **Default:** `'site'`
 *   **Description:** Directory where the static site will be generated.
 
+## `minify`
+*   **Type:** `Boolean`
+*   **Optional**
+*   **Default:** `true` when running `docmd build`, `false` when running `docmd dev`.
+*   **Description:** Controls whether CSS and JavaScript assets are minified (compressed) during the build.
+*   **Usage:** You can force this to `false` if you need to debug production builds.
+*   **Example:** `minify: false`
+
 ### `autoTitleFromH1`
 *   **Type:** `Boolean`
 *   **Default:** `true`
@@ -145,7 +153,9 @@ module.exports = {
 ### `copyCode`
 * **Type:** `Boolean`
 * **Default:** `true`
-* **Description:** If `true`, a "Copy" button will be added to the top-right corner of all code blocks, allowing users to easily copy the code to their clipboard with a single click. **Note:** This setting only applies to regular pages. For noStyle pages, copy code functionality must be explicitly enabled via the `components.mainScripts: true` setting.
+* **Description:** If `true`, a "Copy" button will be added to the top-right corner of all code blocks, allowing users to easily copy the code to their clipboard with a single click.
+
+**Note:** This setting only applies to regular pages. For noStyle pages, copy code functionality must be explicitly enabled via the `components.mainScripts: true` setting.
 
 ## `sidebar` (Object)
 
@@ -218,6 +228,24 @@ Configures the visual theme of your site.
     *   `sitemap: { defaultChangefreq: 'weekly', defaultPriority: 0.8 }`
 *   **See Also:** [Plugins](/plugins/)
 
+## `editLink` (Object, Optional)
+*   **Type:** `Object`
+*   **Description:** Configures a link in the page footer that points to the source file on GitHub (or GitLab/Bitbucket), allowing users to propose changes.
+*   **Properties:**
+    *   `enabled` (Boolean): Set to `true` to show the link.
+    *   `baseUrl` (String): The base URL to your repository's documentation source folder.
+        *   *GitHub Example:* `https://github.com/USERNAME/REPO/edit/main/docs`
+        *   *Note:* Do not include a trailing slash. `docmd` appends the file path automatically.
+    *   `text` (String, Optional): The text to display. Defaults to "Edit this page".
+*   **Example:**
+    ```javascript
+    editLink: {
+      enabled: true,
+      baseUrl: 'https://github.com/mgks/docmd/edit/main/docs',
+      text: 'Edit on GitHub'
+    }
+    ```
+
 ## `navigation` (Array of Objects)
 *   **Description:** Defines the sidebar navigation. (Content mostly same as before, but add the `icon` property explanation).
 *   **Navigation Item Properties:**

package/docs/content/markdown-syntax.md

@@ -197,6 +197,38 @@ docmd supports GitHub Flavored Markdown extensions including:
   
   Renders emoji symbols like: I ❤️ documentation! 🚀 😄
 
+## Custom Attributes (IDs and Classes)
+
+You can add custom IDs and CSS classes to headers, images, and links using curly braces `{}`.
+
+### Custom IDs
+By default, `docmd` generates IDs for headers automatically. You can override this:
+
+```markdown
+## My Header {#custom-id}
+```
+
+### Custom Classes
+Add styling classes to elements:
+
+```markdown
+## Styled Header {.text-center .text-red}
+```
+
+### Links and Buttons
+Create buttons using standard links and classes:
+
+```markdown
+[Download Now](/download){.btn .btn-primary}
+```
+
+### Images
+Control image styling directly:
+
+```markdown
+![Screenshot](image.png){width="100%" .shadow-lg}
+```
+
 ## Footnotes
 
 You can add footnotes to your content for references or additional information[^1].

package/docs/contributing.md

@@ -65,6 +65,14 @@ To enable live change tracking for internal files during development, set the DO
 - **Temporarily:** Run `export DOCMD_DEV=true` in your terminal before starting the dev server.
 - **Permanently:** Add `export DOCMD_DEV=true` to your `~/.zshrc` file and run `source ~/.zshrc`.
 
+### Debugging Build Issues
+
+If you are working on the build process and need to see detailed logs about asset processing or minification, you can run:
+
+```bash
+DOCMD_DEBUG=true docmd build
+```
+
 ## Pull Request Process
 
 Once you're satisfied with your changes:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mgks/docmd",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "Generate beautiful, lightweight static documentation sites directly from your Markdown files. Zero clutter, just content.",
   "main": "src/index.js",
   "exports": {
@@ -44,8 +44,10 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "chokidar": "^4.0.3",
+    "clean-css": "^5.3.3",
     "commander": "^14.0.0",
     "ejs": "^3.1.9",
+    "esbuild": "^0.27.0",
     "express": "^5.1.0",
     "fs-extra": "^11.2.0",
     "gray-matter": "^4.0.3",