@mgks/docmd v0.1.4

Docmd (docmd) is a Node.js command-line tool dedicated to generating beautiful, lightweight static documentation sites from standard Markdown files. It champions the philosophy of "zero clutter, just content," prioritizing ease of use for documentation authors and a clean, performant experience for readers.

Features

• 📝 Markdown First - Standard Markdown with YAML frontmatter
• 🎨 Beautiful Themes - Multiple themes and light/dark modes with syntax highlighting
• 🚀 Fast & Lightweight - Static site generation with minimal JS
• 🧩 Custom Components - Callouts, cards, steps, and more
• 🔌 Built-in Plugins - SEO, Analytics, and Sitemap support
• 🎭 No-Style Pages - Create custom standalone pages with complete HTML control
• 🖌️ Custom Styling - Add custom CSS/JS and HTML directly in frontmatter
• 💻 Simple CLI - Easy init, dev, and build commands
• 🌐 Deploy Anywhere - Deploy the generated sites anywhere (GitHub Pages, Netlify, Vercel, etc.).

Installation

From npm

# Global installation (recommended)
npm install -g @mgks/docmd

# Local project installation
npm install --save-dev @mgks/docmd

Quick Start

# Initialize a new documentation project
docmd init

# Start the development server
docmd dev

# Build for production
docmd build

Documentation

For complete documentation, visit docmd.mgks.dev

Contributing

Contributions are welcome! Please check our contributing guidelines to get started.

1. Fork the repository
2. Clone your fork: git clone https://github.com/YOUR_USERNAME/docmd.git
3. Install dependencies: npm install
4. Make your changes and test them
5. Submit a pull request

License

docmd is licensed under the MIT License.

Support the Project

If you find docmd useful, please consider:

• Starring the repository on GitHub
• Sharing it with others who might benefit
• Reporting issues or submitting pull requests

GitHub Sponsors: Become a monthly or one-time GitHub sponsor to support docmd & other projects developed by me.