DocsJS MarkdownThe Markdown Delivery Layer for docsjs

Why docsjs-markdown? ​

• Two Input Paths, One Output Standard: Use main entry for HTML and /docx for direct DOCX import, then keep one Markdown standard for your team.
• Rule-Based Conversion: Control heading/list/table rendering per tag so docs quality stays consistent across repositories.
• CLI and Pipeline Friendly: Run in CI or batch jobs to generate stable Markdown with optional frontmatter and conversion report metadata.
• Recommended Pair: Use with @coding01/docsjs for import fidelity and @coding01/docsjs-editor for multi-editor processing before publish.

Complete Case ​

import { htmlToGfm } from "@coding01/docsjs-markdown";
import { docxToMarkdown } from "@coding01/docsjs-markdown/docx";

const html = docsjsEditor.getSnapshot();
const markdown = htmlToGfm(html, { frontmatter: true });
const fromDocx = await docxToMarkdown(file, { format: "gfm" });

Left: docsjs HTML snapshot

<h1>Release Plan</h1>
<p>This sprint shipped parser and render upgrades.</p>
<ul>
  <li>DOCX semantic fidelity</li>
  <li>List/table parity</li>
  <li>Markdown output</li>
</ul>

Right: markdown output

# Release Plan

This sprint shipped parser and render upgrades.

- DOCX semantic fidelity
- List/table parity
- Markdown output

API Reference ​

• Main Entry: htmlToMarkdown / htmlToGfm / htmlToStandardMarkdown
• DOCX Entry: docxToMarkdown / docxToMarkdownWithMeta
• CLI: docsjs-markdown ./input.docx -o ./output.md --frontmatter

Engineering Trust Signals ​

• CI: Push to main: run verify quality gate.
• npm: Push tag v*.*.*: publish npm package.
• Pages: Update docs/** on main: deploy landing page.

Recommended Ecosystem Path ​

Use docsjs for high-fidelity input, docsjs-editor for multi-editor processing, and docsjs-markdown for final markdown delivery.

@coding01/docsjs → @coding01/docsjs-markdown → @coding01/docsjs-editor

Quick Start ​

npm install @coding01/docsjs-markdown

yarn add @coding01/docsjs-markdown

pnpm add @coding01/docsjs-markdown

HTML to Markdown ​

import { htmlToGfm } from "@coding01/docsjs-markdown";

const html = "<h1>Hello</h1><p>World</p>";
const markdown = htmlToGfm(html);
console.log(markdown);

Output:

# Hello

World

DOCX to Markdown ​

import { docxToMarkdown } from "@coding01/docsjs-markdown/docx";

const file = input.files[0];
const markdown = await docxToMarkdown(file, {
  format: "gfm",
  frontmatter: true,
});

Ecosystem ​

Sponsors ​