finds.dev← search

// the find

JacksonTian/doxmate

★ 831 · CSS · updated Mar 2019

文档伴侣

Doxmate is a Node.js CLI tool that generates API documentation from JSDoc-style comments, combining dox-parsed annotations with EJS templates and Markdown rendering. It targets Node.js library authors who follow CommonJS and GitHub conventions (README.md in root, source in lib/, docs in doc/). The Chinese-language README signals its primary audience.

Ships three ready-made themes (default Bootstrap-based, WordPress-style, Pomelo) so you get something presentable without touching CSS. The theme export workflow—export, edit locally, rebuild—is a clean way to customize without forking the tool. Built-in gh-pages compatibility means zero extra steps to publish. The dox dependency does the actual comment parsing, so doxmate stays small and focused.

Dead project—last commit was 2019, last meaningful activity was 2012-2013 based on the contributors table. The bundled jQuery 1.8.2 and Bootstrap 3 are over a decade old and carry known CVEs. No JSDoc tag coverage beyond what dox supports, so TypeScript, `@typedef`, `@template`, and modern annotation patterns won't render correctly. Better-maintained alternatives like TypeDoc, JSDoc 4, or Docusaurus have made this obsolete for any new project.

View on GitHub → Homepage ↗

// want more like this?

We dig through GitHub every week and send a few repos picked for what you actually care about — each with an honest take like this one.

Get finds in your inbox → Search again →