document-format-skills
公文格式处理Skill: Professional Word document formatting toolkit for Chinese official documents
Safety scan
A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.
Badge for your README
Markdown
[](/listings/kagurananaga--document-format-skills)HTML
<a href="/listings/kagurananaga--document-format-skills"><img src="/api/listings/kagurananaga--document-format-skills/badge.svg" alt="findsafeskills safety rating" /></a>Install
Install instructions from the README
As written by the repo's author. findsafeskills has not verified these steps.
Smart cleanup:
uv run --with python-docx python scripts/process.py smart input.docx output.docx --preset official
Analyze only:
uv run --with python-docx python scripts/process.py analyze input.docx uv run --with python-docx python scripts/process.py analyze input.docx --json
Punctuation and spacing only:
uv run --with python-docx python scripts/process.py punctuation input.docx output.docx --space-mode keep_en_boundary
Formatting only:
uv run --with python-docx python scripts/process.py format input.docx output.docx --preset official
Create a formatted DOCX from Markdown or text:
uv run --with python-docx python scripts/from_text.py input.md output.docx --title "Work Plan"
What was scanned
The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.
SKILL.md · Manifest · 107 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- ---
- name: document-format-skills
- description: Chinese Word document formatting toolkit for .docx/.doc/.wps workflows. Use when Codex needs to diagnose document formatting, fix mixed Chinese/English punctuation and spacing, apply official/academic/legal/custom presets, normalize tables and page numbers, preserve or output Word revision marks, convert plain text or Markdown into formatted DOCX, or batch/script document cleanup for Chinese official documents.
- ---
- # Document Format Skills
- Use these scripts to clean and format Chinese Word documents from the command line. Prefer `scripts/process.py` for normal work because it mirrors the desktop app's core pipeline without the GUI.
- ## Quick Workflow
- Run one smart pass when the user wants the document cleaned end to end:
- ```bash
- uv run --with python-docx python scripts/process.py smart input.docx output.docx --preset official
- ```
- Run diagnostics only:
- ```bash
- uv run --with python-docx python scripts/process.py analyze input.docx
- uv run --with python-docx python scripts/process.py analyze input.docx --json
- ```
- Run only punctuation/spacing cleanup:
- ```bash
- uv run --with python-docx python scripts/process.py punctuation input.docx output.docx --space-mode keep_en_boundary
- ```
- Run only formatting:
- ```bash
- uv run --with python-docx python scripts/process.py format input.docx output.docx --preset official
- ```
- On Windows, `.doc` and `.wps` input/output are supported through WPS or Microsoft Word COM automation:
- ```bash
- uv run --with python-docx --with pywin32 python scripts/process.py smart input.wps output.wps
- ```
- ## Scripts
- | Script | Use |
- | --- | --- |
- | `scripts/process.py` | One-shot CLI for `smart`, `analyze`, `punctuation`, and `format`; handles `.doc/.wps` conversion on Windows. |
- | `scripts/formatter.py` | Apply formatting presets, custom JSON settings, page numbers, table cleanup, revision marks, macOS font fallback. |
- | `scripts/punctuation.py` | Fix punctuation while preserving run formatting; supports spacing strategies. |
- | `scripts/from_text.py` | Create a DOCX from `.txt` or Markdown, then optionally run smart formatting. |
- | `scripts/analyzer.py` | Lower-level diagnostic script. |
- | `scripts/converter.py` | Windows-only `.doc/.wps` conversion helpers. |
- ## Formatting Options
- Built-in presets:
- - `official`: GB/T 9704-2012 style official document formatting.
- - `academic`: academic paper formatting.
- - `legal`: legal document formatting.
- - `custom`: read the active desktop custom preset when available.
- Useful flags:
- ```bash
- --custom-settings path.json
- --revision
- --deep-clean
- --smart-table-align
- --no-page-number
- --page-number-style dash|plain|page_text|page_total
- --page-number-position outside|left|center|right
- --page-number-offset-mm 7
- --no-bold-serial
- ```
- `--custom-settings` accepts desktop schema v2 config files, exported preset files shaped as `{"preset": {...}}`, or plain preset/override JSON. For non-custom presets, the JSON is merged over the selected preset.
- ## Punctuation And Spacing
- Punctuation cleanup protects URLs, email addresses, Windows paths, time values like `9:30`, and standards like `ISO 9001:2015`. It fixes brackets, colons, semicolons, question/exclamation marks, Chinese comma/period contexts, ellipses, dashes, and paired quotes.
- Spacing modes:
- - `remove_all`: delete half-width and full-width spaces.
- - `keep_en_boundary`: remove Chinese-to-Chinese spaces but keep exactly one space between Chinese and English/digits.
- - `keep_all`: leave spaces unchanged.
- ## Text Or Markdown To DOCX
- Generate and format a document from text:
- ```bash
- uv run --with python-docx python scripts/from_text.py input.md output.docx --title "工作方案"
- ```
- Markdown mode detects headings, bold spans, ordered/unordered lists, quotes, and fenced code blocks. `#` becomes the main title, `##` becomes `一、`, `###` becomes `(一)`, and deeper headings become numbered lower-level headings.
- Use `--no-process` to only create the raw DOCX.
- ## Implementation Notes
- - `.docx` processing needs only `python-docx`.
- - `.doc/.wps` conversion needs Windows plus WPS Office or Microsoft Word and `pywin32`.
- - Page number handling avoids overwriting non-page footer content and can replace existing page-number footers when requested.
- - Default table formatting preserves original alignment; use `--smart-table-align` for numeric/right and short-text/center alignment.
- - macOS font handling keeps installed official fonts when present and falls back to compatible system fonts only when detection confirms the original is missing.
README.md · README · 120 lines
View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)
- # 📄 document-format-skills 公文格式助手
- > **[中文版本 README / Chinese Version](./README_CN.md)**
- >
- > 看不懂英文也没关系,请点击上面的链接查看中文版说明。
- > 💡 **想要无需联网、一键运行修复格式的桌面应用版本?**
- >
- > 现已推出 **[Document Format GUI 公文格式助手](https://github.com/KaguraNanaga/docformat-gui)** —— 无需联网、一键修复公文格式的桌面应用,小白也能轻松上手!
- > 🌐 **不想安装,也不需要 Agent?**
- >
- > 直接打开 **[公文格式处理工具网页版](https://web.gongwengeshizhushou.com)**,选择 `.docx` 文档即可开始处理。无需登录,文档只在当前浏览器中处理,不会上传到服务器。
- A Word document formatting toolkit for Chinese official documents for the government, CCP (China Communist Party), and the state-owned enterprises. Diagnose formatting issues, fix punctuation, and apply standardized styles with one command. Available for Claude Code, Codex, and OpenCode.
- 公文格式助手是一个面向中文公文排版的 Skill 工具包,用于诊断 Word 文档格式问题、修复中英文标点和空格混用、统一公文/论文/法律文书格式、处理页码和表格,并支持从纯文本或 Markdown 生成规范 DOCX。
- ## Features
- - 中文用户如果不熟悉命令行,可以优先使用 [Document Format GUI 公文格式助手](https://github.com/KaguraNanaga/docformat-gui):无需联网、一键修复公文格式。
- - Smart one-shot processing: punctuation/spacing cleanup plus formatting.
- - Format diagnosis for punctuation, numbering, paragraph, and font issues.
- - Official, academic, legal, and custom presets.
- - GB/T 9704-2012 style page margins, fonts, line spacing, headings, signatures, dates, and page numbers.
- - Safer page-number handling with styles, positions, offsets, replacement control, and non-page footer protection.
- - Table normalization with optional smart alignment.
- - Custom settings compatible with the desktop app schema v2 and exported preset JSON.
- - Word revision marks for supported formatting changes.
- - macOS font fallback for common Chinese official-document fonts.
- - `.doc` / `.wps` conversion on Windows when WPS Office or Microsoft Word is installed.
- - Plain text or Markdown to formatted DOCX.
- ## Requirements
- - Python 3.8+
- - `python-docx`
- - `pywin32` only for `.doc/.wps` conversion on Windows
- Use `uv` for ad-hoc runs:
- ```bash
- uv run --with python-docx python scripts/process.py --help
- ```
- For Windows `.doc/.wps` conversion:
- ```bash
- uv run --with python-docx --with pywin32 python scripts/process.py --help
- ```
- ## Quick Start
- Smart cleanup:
- ```bash
- uv run --with python-docx python scripts/process.py smart input.docx output.docx --preset official
- ```
- Analyze only:
- ```bash
- uv run --with python-docx python scripts/process.py analyze input.docx
- uv run --with python-docx python scripts/process.py analyze input.docx --json
- ```
- Punctuation and spacing only:
- ```bash
- uv run --with python-docx python scripts/process.py punctuation input.docx output.docx --space-mode keep_en_boundary
- ```
- Formatting only:
- ```bash
- uv run --with python-docx python scripts/process.py format input.docx output.docx --preset official
- ```
- Create a formatted DOCX from Markdown or text:
- ```bash
- uv run --with python-docx python scripts/from_text.py input.md output.docx --title "Work Plan"
- ```
- ## Useful Options
- ```bash
- --preset official|academic|legal|custom
- --custom-settings path.json
- --revision
- --deep-clean
- --smart-table-align
- --no-page-number
- --page-number-style dash|plain|page_text|page_total
- --page-number-position outside|left|center|right
- --space-mode remove_all|keep_en_boundary|keep_all
- ```
- `--custom-settings` accepts desktop schema v2 config files, exported preset files like `{"preset": {...}}`, or plain preset/override JSON.
- ## Scripts
- | Script | Purpose |
- | --- | --- |
- | `scripts/process.py` | Main CLI pipeline: `smart`, `analyze`, `punctuation`, `format`. |
- | `scripts/formatter.py` | Formatting engine and preset handling. |
- | `scripts/punctuation.py` | Punctuation and spacing fixer. |
- | `scripts/from_text.py` | Text/Markdown to DOCX generator. |
- | `scripts/analyzer.py` | Diagnostic helpers. |
- | `scripts/converter.py` | Windows `.doc/.wps` conversion helpers. |
- ## Notes
- - `.docx` is the most reliable format.
- - `.doc/.wps` requires Windows plus WPS Office or Microsoft Word.
- - Keep a backup of important documents before running automated formatting.
- ## License
- MIT
Ratings and comments
Sign in to rate this skill.
Sign inFree to use. If it’s helped, pass it on.