@phuthuycoding/markcv 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.4] - 2026-09-06
+
+### Fixed
+
+- HTML comments were printed into the PDF instead of being dropped. With
+  markdown-it's `html: false`, comments are escaped into visible text rather than
+  ignored, so a file carrying `<!-- markcv:no-build -->` rendered that marker at
+  the top of the page. Comments are metadata for tooling, never content, and are
+  now stripped before rendering.
+
+## [0.1.3] - 2026-09-06
+
+### Changed
+
+- Package description and keywords rewritten around what people actually search
+  for. `resume-linter` had no package competing for it at all, while `markdown
+  resume` is crowded — so the wording leads with the linting and page-fit work
+  rather than with rendering, which is the part everyone already does.
+- README opens by stating what the tool does differently, and adds a section
+  comparing it with the existing Markdown resume renderers, including when to use
+  one of those instead.
+- Image alt text now describes the resumes shown rather than repeating the tool name.
+
 ## [0.1.2] - 2026-09-06
 
 ### Fixed
@@ -60,7 +83,9 @@ First release.
 - Two ATS-safe themes: `classic` and `compact`.
 - Example CVs in `examples/`, with and without a portrait photo.
 
-[Unreleased]: https://github.com/phuthuycoding/markcv/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/phuthuycoding/markcv/compare/v0.1.4...HEAD
+[0.1.4]: https://github.com/phuthuycoding/markcv/compare/v0.1.3...v0.1.4
+[0.1.3]: https://github.com/phuthuycoding/markcv/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/phuthuycoding/markcv/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/phuthuycoding/markcv/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/phuthuycoding/markcv/releases/tag/v0.1.0

package/README.md

@@ -2,16 +2,17 @@
 
 [![CI](https://github.com/phuthuycoding/markcv/actions/workflows/ci.yml/badge.svg)](https://github.com/phuthuycoding/markcv/actions/workflows/ci.yml)
 [![npm](https://img.shields.io/npm/v/@phuthuycoding/markcv.svg)](https://www.npmjs.com/package/@phuthuycoding/markcv)
+[![docs](https://img.shields.io/badge/docs-markcv-c96442)](https://phuthuycoding.github.io/markcv/)
 
 <p align="center">
-  <img src="docs/screenshots/engineering-lead.png" width="640" alt="A CV rendered by markcv">
+  <img src="docs/screenshots/engineering-lead.png" width="640" alt="Two-page ATS-safe resume PDF generated from Markdown by markcv">
   <br>
   <sub><code>examples/engineering-lead.md</code> — plain Markdown in, two-page A4 PDF out</sub>
 </p>
 
-Build a CV from Markdown — a CLI **and** an MCP server for AI agents.
-
-Two things set it apart from ordinary markdown→PDF tools:
+**Markdown resume builder** that does two things other markdown-to-PDF tools do not:
+it tells you *why* your CV will not fit on two pages, and it lints the writing itself.
+Runs as a CLI and as an **MCP server**, so an AI agent can do both on its own.
 
 - **`fit`** tells you *why* your CV does not fit on 2 pages. "Content too long" and "bad page break" are different illnesses with opposite cures — trimming words while the real culprit is a heading sitting 31px from the bottom of page 1 just wastes your time.
 - **`lint`** checks *content*, not formatting. It catches overselling **and underselling** — claiming less than you did is a mistake too, and it costs you something while gaining nothing.
@@ -82,9 +83,9 @@ how the same format stretches. Each one builds with the default theme and no pho
 
 <table>
 <tr>
-<td width="33%"><a href="docs/screenshots/backend-engineer.png"><img src="docs/screenshots/backend-engineer.png" alt="Backend engineer CV"></a></td>
-<td width="33%"><a href="docs/screenshots/engineering-lead.png"><img src="docs/screenshots/engineering-lead.png" alt="Engineering lead CV"></a></td>
-<td width="33%"><a href="docs/screenshots/data-scientist.png"><img src="docs/screenshots/data-scientist.png" alt="Data scientist CV"></a></td>
+<td width="33%"><a href="docs/screenshots/backend-engineer.png"><img src="docs/screenshots/backend-engineer.png" alt="Backend engineer resume built from Markdown"></a></td>
+<td width="33%"><a href="docs/screenshots/engineering-lead.png"><img src="docs/screenshots/engineering-lead.png" alt="Engineering lead resume, two pages, ATS-safe"></a></td>
+<td width="33%"><a href="docs/screenshots/data-scientist.png"><img src="docs/screenshots/data-scientist.png" alt="Data scientist resume, one page"></a></td>
 </tr>
 <tr>
 <td align="center"><a href="examples/backend-engineer.md">backend-engineer.md</a><br><sub>1 page</sub></td>
@@ -101,7 +102,7 @@ Vietnam, Japan or Germany's more traditional employers usually does. Drop a
 
 <p align="center">
   <a href="docs/screenshots/fullstack-engineer-photo.png">
-    <img src="docs/screenshots/fullstack-engineer-photo.png" width="440" alt="CV with a portrait photo">
+    <img src="docs/screenshots/fullstack-engineer-photo.png" width="440" alt="Markdown resume with a portrait photo in the header">
   </a>
   <br>
   <sub><a href="examples/with-photo/fullstack-engineer.md">examples/with-photo/fullstack-engineer.md</a> — one page, photo auto-detected</sub>
@@ -228,6 +229,28 @@ Plain Markdown. The only convention lives in the header:
 
 `classic` (default) and `compact`. Both are single-column, emoji-free, with a real text layer — safe for ATS parsers.
 
+## How this differs from other Markdown resume tools
+
+Rendering Markdown into a good-looking CV is well covered — [`@resumx/resumx`](https://www.npmjs.com/package/@resumx/resumx),
+[`markdown-resume`](https://www.npmjs.com/package/markdown-resume) and others do it well, and if that is all
+you need, use one of them.
+
+markcv exists for the part that comes after the rendering works:
+
+| | Typical Markdown→PDF tool | markcv |
+|---|---|---|
+| Render to PDF | yes | yes |
+| Themes | yes | two, ATS-safe |
+| **Why it does not fit N pages** | — | names the block, the wasted pixels, and whether length or a page break is at fault |
+| **Content audit** | — | overselling, underselling, tense, unbacked skills, duplicates |
+| **Job-description match** | — | missing requirements, SKILLS-only claims, unrelated bullets |
+| **Usable by an AI agent** | — | MCP server, structured JSON |
+
+## Author
+
+Built by [Ta Manh Quyen](https://quyentm.dev) — a staff engineer who got tired of guessing
+why a CV spilled onto a third page. More writing at [quyentm.dev](https://quyentm.dev).
+
 ## License
 
 MIT

package/dist/core/markdown.d.ts

@@ -1,5 +1,5 @@
 import type { CvDoc } from "../types.js";
-export declare function parseCv(raw: string): CvDoc;
+export declare function parseCv(input: string): CvDoc;
 /**
  * Markdown -> page body HTML.
  * The header (name + contact lines) is wrapped in .header so the portrait can be

package/dist/core/markdown.js

@@ -1,10 +1,19 @@
 import MarkdownIt from "markdown-it";
 const md = new MarkdownIt({ html: false, linkify: false, typographer: false });
+/**
+ * HTML comments carry metadata for tools (markcv:no-build and friends), never
+ * content. With `html: false` markdown-it escapes them into visible text rather
+ * than dropping them, so strip them before rendering.
+ */
+function stripComments(raw) {
+    return raw.replace(/<!--[\s\S]*?-->/g, "");
+}
 /** A header contact line: `**Label:** value` (no `|`, unlike a job-title line). */
 const CONTACT_RE = /^<p><strong>[^<]+:<\/strong>[^|]*<\/p>$/;
 /** A job-title line: `**Job Title** | 2020 - 2021`. */
 const META_RE = /^<p><strong>.*\|.*<\/p>$/;
-export function parseCv(raw) {
+export function parseCv(input) {
+    const raw = stripComments(input);
     const lines = raw.split("\n");
     const sections = [];
     lines.forEach((line, i) => {
@@ -23,7 +32,7 @@ export function parseCv(raw) {
  * be laid out as one block.
  */
 export function renderBody(raw, photoHtml) {
-    const html = md.render(raw);
+    const html = md.render(stripComments(raw));
     const blocks = html.split("\n").filter((l) => l.trim() !== "");
     const out = [];
     let headerOpen = false;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@phuthuycoding/markcv",
-  "version": "0.1.2",
-  "description": "Fit, lint and build a CV from Markdown - CLI + MCP server for AI agents",
+  "version": "0.1.4",
+  "description": "Markdown resume builder that lints your CV and explains why it will not fit two pages. ATS-safe PDF, job-description tailoring, CLI + MCP server for AI agents.",
   "type": "module",
   "bin": {
     "markcv": "dist/cli.js",
@@ -31,14 +31,27 @@
     "changelog": "node scripts/changelog.mjs"
   },
   "keywords": [
-    "cv",
     "resume",
+    "cv",
+    "resume-builder",
+    "cv-builder",
+    "markdown-resume",
     "markdown",
+    "markdown-to-pdf",
     "pdf",
-    "mcp",
+    "resume-template",
+    "resume-linter",
+    "resume-checker",
     "ats",
-    "lint",
-    "page-fit"
+    "ats-friendly",
+    "ats-resume",
+    "mcp",
+    "mcp-server",
+    "model-context-protocol",
+    "claude",
+    "ai-agent",
+    "cli",
+    "job-search"
   ],
   "license": "MIT",
   "dependencies": {