https://github.com/codedynasty-dev/docmach
Docmach, the Markdown-powered static site generator designed for blogs and project documentation.
https://github.com/codedynasty-dev/docmach
Last synced: 2 months ago
JSON representation
Docmach, the Markdown-powered static site generator designed for blogs and project documentation.
- Host: GitHub
- URL: https://github.com/codedynasty-dev/docmach
- Owner: CodeDynasty-dev
- License: mit
- Created: 2025-02-25T00:45:11.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-27T16:17:57.000Z (2 months ago)
- Last Synced: 2025-03-27T17:28:17.296Z (2 months ago)
- Language: HTML
- Homepage: https://docmach.codedynasty.dev
- Size: 936 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Docmach
**Docmach** is a **Markdown-powered** static site generator designed for **modern blogs and project documentation**. It integrates **the simplicity of Markdown and Tailwind CSS** to generate sites with minimal effort.
## Features
- **Markdown Compilation** – Write Markdown, and let Docmach handle the rest
- **Tailwind CSS Integration** – Built-in Tailwind CSS compiler for beautiful, responsive designs
- **Custom Themes** – Choose from available themes or create your own
- **Live Reload & Watch Mode** – Instant preview while editing your content
- **Performance Optimized** – Fast build times and optimized output
- **Simple Configuration** – Minimal setup required to get started
[See more](https://docmach.codedynasty.dev/)
## Installation
```sh
# Install locally
npm i docmach
npx docmach
# Or install globally
npm i docmach -g
docmach
```
## Configuration
Add the following to your `package.json` file:
```json
"docmach": {
"docs-directory": "./docs",
"build-directory": "./docmach",
"assets-folder": "./assets"
}
```
### Configuration Options
| Option | Description | Default |
|--------|-------------|---------|
| **docs-directory** | Directory containing your Markdown files | Root directory |
| **build-directory** | Output directory for the generated site | `./docmach` |
| **assets-folder** | Directory with assets to be copied to output | None |
## 🧩 How Docmach Works
Docmach parses all .md files in your input folder, extracting and processing Markdown and HTML content. It uses special Docmach tag to apply templates and functions.
### Docmach tag
Docmach tag work similarly to HTML tags:
```html
```
### Using Fragment
```html
{{ title }}
{{ author }}
```
### Using Function tags
```js
// in author-bio.js
export default function (title,author) {
return `
by ${title}
by ${author.name}
Aged: ${author.age}
On: ${author.date}
`
}
// such functions should do it works fast please.
```
### Docmach Attributes
| Attribute | Type | Description |
|-----------|------|-------------|
| **type** | string | Template type: `"fragment"` or `"function"` |
| **file** | string | Location of template code: `.html` for fragments or `.js` for functions |
| **params** | string | Parameters passed to templates as `{{ key }}` in HTML fragments or as function parameters |
## Why Choose Docmach?
- **Live Reload That Actually Works** 🔄 – See changes instantly
- **CLI That Doesn't Get in Your Way** 🛠️ – Simple, intuitive commands
- **Developer Experience Focused** 🌟 – Built with modern web development workflows in mind
- **Flexible & Extensible** 🧩 – Adapt to your project needs without complexity
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.
## License
MIT