formaldoc

Category: Docs & Knowledge | Uploader: shrektan | Downloads: 0 | Version: v1.0（Latest）

Convert Markdown text or Markdown artifacts into professionally formatted .docx files using the formaldoc npm package. Use this skill whenever the user wants to export, download, or save Markdown content as a Word document (.docx), or asks to "generate a docx", "export to Word", "turn this into a Word file", "download as docx", or "save as document". Also trigger when the user has a Markdown artifact and asks for a formatted document version. Always prefer this skill over manual docx generation when Markdown source is available.

Changelog: Source: GitHub https://github.com/shrektan/formaldoc

Directory Structure

Current level: skills/formaldoc/

📄 SKILL.md 4.1 KB

SKILL.md

---
name: formaldoc
description: |
  Convert Markdown text or Markdown artifacts into professionally formatted .docx files using the formaldoc npm package. Use this skill whenever the user wants to export, download, or save Markdown content as a Word document (.docx), or asks to "generate a docx", "export to Word", "turn this into a Word file", "download as docx", or "save as document". Also trigger when the user has a Markdown artifact and asks for a formatted document version. Always prefer this skill over manual docx generation when Markdown source is available.

  Available templates:
  - cn-gov      Chinese official document, GB/T 9704 style
  - cn-general  Chinese general-purpose document
  - cn-academic Chinese academic paper
  - cn-report   Chinese business or work report
  - en-standard Standard — Times New Roman + Arial
  - en-business Business — Calibri + Arial, modern
  - en-academic Academic — APA style, double-spaced
  - en-legal    Legal — Contracts, legal docs
---

# formaldoc Skill

Convert Markdown to `.docx` using the published `formaldoc` npm package.

## When to use

Use this skill when the user wants a real Word document output rather than only Markdown or plain text.

Common triggers:

- "generate a docx"
- "export this to Word"
- "turn this markdown into a document"
- "save this as a .docx"
- "download a Word file"

## Workflow

### 1. Determine the template

If the user already picked a template or the context makes it obvious, use it directly.

If the template is unclear, ask once and keep it brief.

Default guidance:

- `cn-report` for Chinese business or work-report content
- `cn-gov` for Chinese official or government-style content
- `en-business` for English professional content
- fallback default: `cn-gov`

Short prompt example:

> Which template should I use? Default is `cn-report`. Available options: `cn-gov` / `cn-general` / `cn-academic` / `cn-report` / `en-standard` / `en-business` / `en-academic` / `en-legal`

### 2. Install the package

```bash
npm install formaldoc
```

If a one-off run is better, `npx formaldoc ...` is also valid.

### 3. Prefer file-based conversion when a `.md` file already exists

If Markdown already exists on disk, use `convertMarkdownToDocxFile`.

```ts
import { convertMarkdownToDocxFile } from 'formaldoc';

const result = await convertMarkdownToDocxFile({
  inputPath: '/absolute/path/to/input.md',
  outputPath: '/absolute/path/to/output.docx',
  templateName: 'cn-report',
});

console.log(result.outputPath);
```

### 4. Fall back to in-memory conversion only when needed

If the Markdown only exists in the conversation and not as a file, use `convertMarkdownToDocx`.

```ts
import { writeFile } from 'node:fs/promises';
import { convertMarkdownToDocx } from 'formaldoc';

const result = await convertMarkdownToDocx({
  markdown: '# Title\n\nGenerated by an AI tool.',
  templateName: 'cn-report',
});

await writeFile('/absolute/path/to/output.docx', result.buffer);
```

### 5. Return the generated file

The final output should be the `.docx` file itself whenever the environment supports returning files.

## CLI fallback

If the environment is simpler or file-based, use the CLI:

```bash
npx formaldoc input.md -t cn-report -o output.docx
```

Or with stdin:

```bash
cat input.md | npx formaldoc --stdin -t cn-report -o output.docx
```

## Important notes

- `formaldoc` is ESM-first. Prefer `import`, not `require()`.
- Prefer absolute paths in agent environments.
- Prefer file-based conversion when a Markdown file already exists.
- Choose an output filename that matches the document title when practical.
- Return the real `.docx` artifact, not just a path or a success message.

## Template cheat sheet

| Context | Recommended template |
| --- | --- |
| Chinese work reports, updates, analysis | `cn-report` |
| Government, regulatory, or official Chinese docs | `cn-gov` |
| General Chinese documents | `cn-general` |
| Chinese academic content | `cn-academic` |
| English business content | `en-business` |
| English academic content | `en-academic` |
| English legal content | `en-legal` |
| General English document | `en-standard` |

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

formaldoc

Directory Structure

SKILL.md

Report

Notice