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.
# Install locally
npm i docmach
npx docmach
# Or install globally
npm i docmach -g
docmach
Add the following to your package.json file:
"docmach": {
"docs-directory": "./docs",
"build-directory": "./docmach",
"assets-folder": "./assets"
}
| 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 |
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 work similarly to HTML tags:
<docmach
type="fragment"
file="template.html"
params="title=My Page; author=JohnDoe"
/>
<!-- Yes this works, passed as function parameter -->
<docmach
type="function"
file="author-bio.js"
params="title=My Page; author={name: JohnDoe, age: 24, date: 20th March 2015}"
/>
<!-- template.html -->
<html>
<head>
<title>{{ title }}</title>
</head>
<body>
<h2>{{ author }}</h2>
</body>
// in author-bio.js
export default function (title,author) {
return `
<div>
<h1>by ${title}</h1>
<h3>by ${author.name}</h3>
<p>Aged: ${author.age}</p>
<p>On: ${author.date}</p>
</div>
`
}
// such functions should do it works fast please.
| 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 |
Contributions are welcome! Feel free to open issues or submit pull requests.
MIT
FAQs
Docmach - markdown compiler for blogs & project Documentation 🚀
The npm package docmach receives a total of 13 weekly downloads. As such, docmach popularity was classified as not popular.
We found that docmach demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.