{"id":26759804,"url":"https://github.com/codedynasty-dev/docmach","last_synced_at":"2026-04-21T15:01:19.272Z","repository":{"id":279325863,"uuid":"938439960","full_name":"CodeDynasty-dev/Docmach","owner":"CodeDynasty-dev","description":"Docmach, the Markdown-powered static site generator designed for blogs and project documentation.","archived":false,"fork":false,"pushed_at":"2025-03-27T16:17:57.000Z","size":958,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-27T17:28:17.296Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docmach.codedynasty.dev","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeDynasty-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-25T00:45:11.000Z","updated_at":"2025-03-27T16:18:00.000Z","dependencies_parsed_at":"2025-03-18T19:44:11.955Z","dependency_job_id":null,"html_url":"https://github.com/CodeDynasty-dev/Docmach","commit_stats":null,"previous_names":["codedynasty-foo/credence","codedynasty-dev/credence","codedynasty-dev/docmach"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDynasty-dev%2FDocmach","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDynasty-dev%2FDocmach/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDynasty-dev%2FDocmach/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeDynasty-dev%2FDocmach/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeDynasty-dev","download_url":"https://codeload.github.com/CodeDynasty-dev/Docmach/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246068303,"owners_count":20718505,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-28T17:28:21.891Z","updated_at":"2026-01-06T23:36:34.523Z","avatar_url":"https://github.com/CodeDynasty-dev.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docmach\n\n**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.\n\n## Features\n\n- **Markdown Compilation** – Write Markdown with full HTML support and syntax highlighting\n- **Custom Templating System** – Use fragments, functions, and wrappers via `\u003cdocmach\u003e` tags\n- **Tailwind CSS Integration** – Built-in Tailwind CSS compiler for beautiful, responsive designs\n- **Live Reload \u0026 Watch Mode** – Instant preview with WebSocket-based hot reload\n- **Incremental Builds** – Smart caching and dependency tracking for fast rebuilds\n- **Build Manifest** – Auto-generated JSON manifest with page metadata and tag information\n- **Programmatic API** – Use Docmach as a library for dynamic content generation\n- **Simple Configuration** – Minimal setup required to get started\n\n[See more](https://docmach.codedynasty.dev/)\n\n## Installation\n\n```sh\n# Install locally\nnpm i docmach\nnpx docmach\n\n# Or install globally\nnpm i docmach -g\ndocmach\n```\n\n## Configuration\n\nAdd the following to your `package.json` file:\n\n```json\n\"docmach\": {\n  \"docs-directory\": \"./docs\",\n  \"build-directory\": \"./docmach\",\n  \"assets-folder\": \"./assets\"\n}\n```\n\n### Configuration Options\n\n| Option              | Description                                  | Default        |\n| ------------------- | -------------------------------------------- | -------------- |\n| **docs-directory**  | Directory containing your Markdown files     | Root directory |\n| **build-directory** | Output directory for the generated site      | `./docmach`    |\n| **assets-folder**   | Directory with assets to be copied to output | None           |\n\n## 🧩 How Docmach Works\n\nDocmach 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.\n\n### Docmach tag\n\nDocmach tag work similarly to HTML tags:\n\n```html\n\u003cdocmach\n  type=\"fragment\"\n  file=\"template.html\"\n  params=\"title=My Page; author=JohnDoe\"\n/\u003e\n\n\u003c!-- Yes this works, passed as function parameter --\u003e\n\u003cdocmach\n  type=\"function\"\n  file=\"author-bio.js\"\n  params=\"title=My Page; author={name: JohnDoe, age: 24, date: 20th March 2015}\"\n/\u003e\n```\n\n### Using Fragment\n\n```html\n\u003c!-- template.html --\u003e\n\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003ctitle\u003e{{ title }}\u003c/title\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003ch2\u003e{{ author }}\u003c/h2\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n```\n\n### Using Function tags\n\n```js\n// in author-bio.js\nexport default function (title, author) {\n  return `\n   \u003cdiv\u003e\n   \u003ch1\u003eby ${title}\u003c/h1\u003e\n   \u003ch3\u003eby ${author.name}\u003c/h3\u003e\n   \u003cp\u003eAged: ${author.age}\u003c/p\u003e\n   \u003cp\u003eOn: ${author.date}\u003c/p\u003e\n   \u003c/div\u003e\n   `;\n}\n// such functions should do it works fast please.\n```\n\n### Docmach Attributes\n\n| Attribute       | Type   | Description                                                               |\n| --------------- | ------ | ------------------------------------------------------------------------- |\n| **type**        | string | Template type: `\"fragment\"`, `\"function\"`, or `\"wrapper\"`                 |\n| **file**        | string | Location of template code: `.html` for fragments or `.js` for functions   |\n| **params**      | string | Parameters passed to templates (supports objects: `key: {nested: value}`) |\n| **replacement** | string | (Wrapper only) Placeholder name where content will be inserted            |\n\n### Using Wrapper Tags\n\nWrappers allow you to wrap Markdown content with custom HTML:\n\n```html\n\u003cdocmach\n  type=\"wrapper\"\n  file=\"layout.html\"\n  replacement=\"content\"\n  params=\"title: My Page\"\n\u003e\n  # This Markdown content will be wrapped Your content here gets inserted into\n  the `{{ content }}` placeholder.\n\u003c/docmach\u003e\n```\n\n## CLI Commands\n\n```bash\ndocmach              # Start dev server with live reload\ndocmach build        # Build for production\ndocmach print        # Visualize all pages in your site\n```\n\n## Build Manifest\n\nDocmach automatically generates `docmach-manifest.json` during builds, containing:\n\n- All page paths and URLs\n- Docmach tags used in each page\n- Template dependencies and parameters\n\nPerfect for building navigation, sitemaps, or analyzing your site structure.\n\n## Why Choose Docmach?\n\n- **Live Reload That Actually Works** 🔄 – See changes instantly\n- **CLI That Doesn't Get in Your Way** 🛠️ – Simple, intuitive commands\n- **Developer Experience Focused** 🌟 – Built with modern web development workflows in mind\n- **Flexible \u0026 Extensible** 🧩 – Adapt to your project needs without complexity\n\n## Roadmap\n\nSee [ROADMAP.md](ROADMAP.md) for planned features and future direction.\n\n**Upcoming features:**\n\n- Plugin system for extensibility\n- Frontmatter support (YAML/TOML)\n- Collections and taxonomies\n- i18n support\n- CMS integrations\n\n## Contributing\n\nWe welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.\n\n**Quick start:**\n\n```bash\ngit clone https://github.com/CodeDynasty-dev/Docmach.git\ncd Docmach\nnpm install\nnpm run watch\n```\n\n## Documentation\n\n- [Introduction](docs/docs/introduction.md)\n- [Quickstart Guide](docs/docs/quickstart.md)\n- [Configuration](docs/docs/configuration.md)\n- [Advanced Features](docs/docs/advanced-features.md)\n- [API Reference](docs/docs/api-reference.md)\n\n## License\n\nApache License 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodedynasty-dev%2Fdocmach","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodedynasty-dev%2Fdocmach","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodedynasty-dev%2Fdocmach/lists"}