CodeToDoc

CodeToDoc is a tool that generates Word documents from code.

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

Install

npm i -g @sohcah/code-to-doc

Usage

code-to-doc [folder]

Configuration

Ignore Files

CodeToDoc will ignore all files listed in your .gitignore.

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

Other Configuration

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

An example is below:

{
  "shikiTheme": "nord",
  "fileTypes": [
    ["xml", "xml"],
    ["/yarn\\.lock$/", "yaml"]
  ],
  "tabWidth": 4,
  "continuous": true
}