KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

toDoc

★ 39 Open GitHub ↗

JavaScript library to create create a Word document with Text/HTML

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## toDoc.js 
JS library to create create a Word document with Text/HTML

Methods :
 * [toDoc.createSection(sectionType, contentType, content, position, align, size, font)](#toDoc.createSection)
 * [toDoc.createContent(type, content, position, align, size, font)](#toDoc.createContent)
 * [toDoc.createImage(sectionType, imageURL, position, align, imageWidth, imageHeight)](#toDoc.createImage)
 * [toDoc.createPagenumber(sectionType, format, align, size, font)](#toDoc.createPagenumber)
 * [toDoc.createDocument(fileName, params)](#toDoc.createDocument)
 * [toDoc.clearDocument()](#toDoc.clearDocument)

### toDoc.createSection(sectionType, contentType, content, position, align, size, font)
Creates a Header or a Footer Section in the document

**Kind**: static method of [<code>toDoc</code>](#toDoc)
**Access**: public

| Param | Type | Description |
| --- | --- | --- |
| sectionType | <code>string</code> | Specifies whether to create content for the header or footer of the document Accepts : "header" &#124; "footer" Required |
| contentType | <code>string</code> | Defines whether the content is Text or stringified HTML markup Accepts : "text" &#124; "html" Required |
| content | <code>string</code> | The content that will be inserted in the document Accepts : stringified text &#124; stringified HTML markup Required |
| position | <code>number</code> | Specifies the content's position in the section Header/Footer content will be sorted by positon during document generation Accepts : Numbers > 0 Default position : 0 Optional |
| align | <code>string</code> | Specifies the content's alignemnt Accepts : "left" &#124; "center" &#124; "right" &#124; "justify" Default alignment : left Optional |
| size | <code>string</code> | Specifies the content's font size Accepts : CSS font-size Default size : 12pt/16px/1em Optional |
| font | <code>string</code> | Specifies the content's font family Accepts : CSS font-family Default font : Times New Roman Optional |

### toDoc.createContent(type, content, position, align, size, font)
Creates a Paragraph or Page in the document

**Kind**: static method of [<code>toDoc</code>](#toDoc)
**Access**: public

| Param | Type | Description |
| --- | --- | --- |
| type | <code>string</code> | Defines whether the content is a Paragraph or a Page Accepts : "paragraph" : Inserts a paragraph in the next line &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; "page" : Inserts a paragraph in the next page Required |
| content | <code>string</code> | The content that will be created in the document Accepts : Text &#124; Stringified HTML Required |
| position | <code>number</code> | Specifies the content's position in the document Paragraphs and pages will be sorted by positon during document generation Accepts : Numbers > 0 Default position : 0 Required for pagagraphs and pages Optional if passing a whole HTML document |
| align | <code>string</code> | Specifies the content's alignemnt Accepts : "left" &#124; "center" &#124; "right" &#124; "justify" Default alignment : left Optional |
| size | <code>string</code> | Specifies the content's font size Accepts : CSS font-size Default size : 12pt/16px/1em Optional |
| font | <code>string</code> | Specifies the content's font family Accepts : CSS font-family Default font : Times New Roman Optional |

### toDoc.createImage(sectionType, imageURL, position, align, imageWidth, imageHeight)
Creates an image in the Header, Footer or Body  of the document

**Kind**: static method of [<code>toDoc</code>](#toDoc)
**Access**: public

| Param | Type | Description |
| --- | --- | --- |
| sectionType | <code>string</code> | Defines the section where the image will be created Accepts : "header" &#124; "footer" &#124; "body" Required |
| imageURL | <code>string</code> | Specifies the image's URL Accepts : image URL &#124; base64 data URL Required |
| position | <code>number</code> | Specifies the image's position in the document Images will be sorted by position along with Header/Footer/Paragraphs/Pages during document generation Accepts : Numbers > 0 Default position : 0 Optional |
| align | <code>string</code> | Defines the image's alignemnt Accepts : "left" &#124; "center" &#124; "right" Default alignment : left Optional |
| imageWidth | <code>number</code> | Specify a custom width for images Use only for resizing images Accepts : Numbers > 0 Optional |
| imageHeight | <code>number</code> | Specify a custom height for images Use only for resizing images Accepts : Numbers > 0 Optional |

### toDoc.createPagenumber(sectionType, format, align, size, font)
Inserts a page number in specified section of the document

**Kind**: static method of [<code>toDoc</code>](#toDoc)
**Access**: public

| Param | Type | Description |
| --- | --- | --- |
| sectionType | <code>string</code> | Defines the section where the page number is inserted in the document Accepts : "header" &#124; "footer" Required |
| format | <code>number</code> | Specifies the page number's format Accepts : 1 : Only page number &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 2 : Page X of Y Default value : 1 Optional |
| align | <code>string</code> | Specifies the page number's alignemnt Accepts : "left" &#124; "center" &#124; "right" Default alignment : left Optional |
| size | <code>string</code> | Specifies the page number's font size Accepts : CSS font-size Default size : 12pt/16px/1em Optional |
| font | <code>string</code> | Specifies the page number's font family Accepts : CSS font-family Default font : Times New Roman Optional |

### toDoc.createDocument(fileName, params)
Generates and saves a Word document

Default document layout, use this as template for custom parameters:
```javascript
{
 "pageSizeX": "8.5in",
 "pageSizeY": "11in",
 "marginTop": "1in",
 "marginBottom": "1in",
 "marginLeft": "1in",
 "marginRight": "1in",
 "headerMargin": "0.5in",
 "footerMargin": "0.5in",
}
```
**Kind**: static method of [<code>toDoc</code>](#toDoc)
**Access**: public

| Param | Type | Description |
| --- | --- | --- |
| fileName | <code>string</code> | Specifies the name of the document Required |
| params | <code>object</code> | Define custom parameters for the document's layout Accepts : JSON Object Optional |

### toDoc.clearDocument()
Clears all created document data

**Kind**: static method of [<code>toDoc</code>](#toDoc)
**Access**: public

toDoc

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README