Code2Docx

Code2Docx is a tool that generates Word documents from code.

It uses Shiki for Syntax Highlighting, and Docx for generating the Word document.

Usage

1npx code2docx@latest [folder]

or install globally with

1npm i -g code2docx@latest
2# Then run with
3code2docx [folder]

Configuration

Ignore Files

Code2Docx will ignore all files listed in your .gitignore.

If you want to ignore files only for Code2Docx, you can create a .code2docxignore file with the same syntax as a .gitignore.

Other Configuration

You can create a .code2docx.json configuration file in your project root.

An example is below:

1{
2  "shikiTheme": "nord",
3  "fileTypes": [
4    ["xml", "xml"],
5    ["/yarn\\.lock$/", "yaml"],
6    [
7      "overpassql",
8      {
9        "scopeName": "source.overpass",
10        "path": "./overpassql.json"
11      }
12    ]
13  ],
14  "tabWidth": 4,
15  "continuous": true,
16  "heading": {
17    "font": "Consolas",
18    "type": "heading1"
19  },
20  "code": {
21    "font": "JetBrains Mono",
22    "size": 12
23  }
24}