open-index/open-npm huggingface dataset:
npm package: @sohcah/code-to-doc
Description: ![Example Document](example.png)
Latest version: 0.0.4

# CodeToDoc

![Example Document](example.png)

CodeToDoc is a tool that generates Word documents from code.

It uses [Shiki](https://shiki.matsu.io/) for Syntax Highlighting, and [Docx](https://docx.js.org/) for generating the Word document.

### Install

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

### Usage

```bash
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:

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