html-to-docx ============ [![NPM Version][npm-image]][npm-url] html-to-docx is a js library for converting HTML documents to DOCX format supported by Microsoft Word 2007+, LibreOffice Writer, Google Docs, WPS Writer etc. It was inspired by [html-docx-js] project but mitigates the problem of documents generated being non-compatiable with word processors like Google Docs and libreOffice Writer that doesn't support [altchunks] feature. html-to-docx earlier used to use [libtidy] to clean up the html before parsing, but had to remove it since it was causing so many dependency issues due to node-gyp. ### Disclaimer Even though there is an instance of html-to-docx running in production, please ensure that it covers all the cases that you might be encountering usually, since this is not a complete solution. Currently it doesn't work with browser directly, but it was tested against React. ## Installation Use the npm to install foobar. ```bash npm install html-to-docx ``` ## Usage ```js await HTMLtoDOCX(htmlString, headerHTMLString, documentOptions, footerHTMLString) ``` full fledged examples can be found under `example/` ### Parameters - `htmlString` <[String]> clean html string equivalent of document content. - `headerHTMLString` <[String]> clean html string equivalent of header. Defaults to `

` if header flag is `true`. - `documentOptions` - `orientation` <"portrait"|"landscape"> defines the general orientation of the document. Defaults to portrait. - `pageSize` Defaults to U.S. letter portrait orientation. - `width` <[Number]> width of the page for all pages in this section in [TWIP]. Defaults to 12240. Maximum 31680. Supports equivalent measurement in [pixel], [cm] or [inch]. - `height` <[Number]> height of the page for all pages in this section in [TWIP]. Defaults to 15840. Maximum 31680. Supports equivalent measurement in [pixel], [cm] or [inch]. - `margins` - `top` <[Number]> distance between the top of the text margins for the main document and the top of the page for all pages in this section in [TWIP]. Defaults to 1440. Supports equivalent measurement in [pixel], [cm] or [inch]. - `right` <[Number]> distance between the right edge of the page and the right edge of the text extents for this document in [TWIP]. Defaults to 1800. Supports equivalent measurement in [pixel], [cm] or [inch]. - `bottom` <[Number]> distance between the bottom of text margins for the document and the bottom of the page in [TWIP]. Defaults to 1440. Supports equivalent measurement in [pixel], [cm] or [inch]. - `left` <[Number]> distance between the left edge of the page and the left edge of the text extents for this document in [TWIP]. Defaults to 1800. Supports equivalent measurement in [pixel], [cm] or [inch]. - `header` <[Number]> distance from the top edge of the page to the top edge of the header in [TWIP]. Defaults to 720. Supports equivalent measurement in [pixel], [cm] or [inch]. - `footer` <[Number]> distance from the bottom edge of the page to the bottom edge of the footer in [TWIP]. Defaults to 720. Supports equivalent measurement in [pixel], [cm] or [inch]. - `gutter` <[Number]> amount of extra space added to the specified margin, above any existing margin values. This setting is typically used when a document is being created for binding in [TWIP]. Defaults to 0. Supports equivalent measurement in [pixel], [cm] or [inch]. - `title` title of the document. - `subject` subject of the document. - `creator` creator of the document. Defaults to `html-to-docx` - `keywords` > keywords associated with the document. Defaults to ['html-to-docx']. - `description` description of the document. - `lastModifiedBy` last modifier of the document. Defaults to `html-to-docx`. - `revision` revision of the document. Defaults to `1`. - `createdAt` time of creation of the document. Defaults to current time. - `modifiedAt` time of last modification of the document. Defaults to current time. - `headerType` <"default"|"first"|"even"> type of header. Defaults to `default`. - `header` flag to enable header. Defaults to `false`. - `footerType` <"default"|"first"|"even"> type of footer. Defaults to `default`. - `footer` flag to enable footer. Defaults to `false`. - `font` font name to be used. Defaults to `Times New Roman`. - `fontSize` size of font in HIP(Half of point). Defaults to `22`. Supports equivalent measure in [pt]. - `complexScriptFontSize` size of complex script font in HIP(Half of point). Defaults to `22`. Supports equivalent measure in [pt]. - `table` - `row` - `cantSplit` flag to allow table row to split across pages. Defaults to `false`. - `pageNumber` flag to enable page number in footer. Defaults to `false`. Page number works only if footer flag is set as `true`. - `skipFirstHeaderFooter` flag to skip first page header and footer. Defaults to `false`. - `lineNumber` flag to enable line numbering. Defaults to `false`. - `lineNumberOptions` - `start` <[Number]> start of the numbering - 1. Defaults to `0`. - `countBy` <[Number]> skip numbering in how many lines in between + 1. Defaults to `1`. - `restart` <"continuous"|"newPage"|"newSection"> numbering restart strategy. Defaults to `continuous`. - `numbering` - `defaultOrderedListStyleType` default ordered list style type. Defaults to `decimal`. - `decodeUnicode` flag to enable unicode decoding of header, body and footer. Defaults to `false`. - `lang` language localization code for spell checker to work properly. Defaults to `en-US`. - `footerHTMLString` <[String]> clean html string equivalent of footer. Defaults to `

` if footer flag is `true`. ### Returns <[Promise]<[Buffer]|[Blob]>> ## Notes Currently page break can be implemented by having div with classname "page-break" or style "page-break-after" despite the values of the "page-break-after", and contents inside the div element will be ignored. `

` CSS list-style-type for `

List item

パッケージ	ダウンロード数	Stars	サイズ	Issues	公開日時	ライセンス

html-to-docx	36,113	424	4.8 MB	98	2年前	MIT