Michael Williamson

Mammoth is designed to convert .docx documents, such as those created by Microsoft Word, Google Docs and LibreOffice, and convert them to HTML. Mammoth aims to produce simple and clean HTML by using semantic information in the document, and ignoring other details. For instance, Mammoth converts any paragraph with the style <code>Heading1</code> to <code>h1</code> elements, rather than attempting to exactly copy the styling (font, text size, colour, etc.) of the heading. This allows you to paste from Word documents without the usual mess.
There’s a large mismatch between the structure used by .docx and the structure of HTML, meaning that the conversion is unlikely to be perfect for more complicated documents. Mammoth works best if you only use styles to semantically mark up your document.
The following features are currently supported:
<ul>
<li>
Headings.
</li>
<li>
Lists.
</li>
<li>
Tables. The formatting of the table itself, such as borders, is currently ignored, but the formatting of the text is treated the same as in the rest of the document.
</li>
<li>
Footnotes and endnotes.
</li>
<li>
Images.
</li>
<li>
Bold, italics, superscript and subscript.
</li>
<li>
Links.
</li>
<li>
Text boxes. The contents of the text box are treated as a separate paragraph that appears after the paragraph containing the text box.
</li>
</ul>
<h4>Embedded style maps</h4>
By default, Mammoth maps some common .docx styles to HTML elements. For instance, a paragraph with the style name <code>Heading 1</code> is converted to a <code>h1</code> element. If you have a document with your own custom styles, you can use an embedded style map to tell Mammoth how those styles should be mapped. For instance, you could convert paragraphs with the style named <code>WarningHeading</code> to <code>h1</code> elements with <code>class="warning"</code> with the style mapping:
<pre><code>p[style-name='WarningHeading'] => h1.warning:fresh
</code></pre>
<a href="http://mike.zwobble.org/projects/mammoth/embed-style-map/" rel="nofollow ugc">An online tool</a> can be used to embed style maps into an existing document. Details of <a href="https://github.com/mwilliamson/mammoth.js#writing-style-maps" rel="nofollow ugc">how to write style maps can be found on the mammoth.js documentation</a>.
A style map to be used for all documents can be set by configuring Mammoth (see below).
<h4>Configuration</h4>
Mammoth can be configured by writing a separate plugin. For instance, <a href="https://github.com/mwilliamson/mammoth-wordpress-plugin/tree/master/examples/options-plugin" rel="nofollow ugc">this example plugin</a> adds a custom style map, and uses a document transform to detect paragraphs of monospace text and converts them to paragraphs with the style “Code Block”.
As a WordPress plugin, Mammoth uses the JavaScript library mammoth.js to convert documents. Mammoth will use the JavaScript global <code>MAMMOTH_OPTIONS</code> whenever calling mammoth.js, which allows for some customisation. <code>MAMMOTH_OPTIONS</code> should be defined as a function that returns an options object. This options object will then be passed in as the <code>options</code> argument to <code>convertToHtml</code>. The <a href="https://github.com/mwilliamson/mammoth.js" rel="nofollow ugc">mammoth.js docs</a> describe the various options available.
The global <code>MAMMOTH_OPTIONS</code> will be called with <code>mammoth</code> as the first argument. This can be useful if you need to use a function from mammoth.js, such as <code>mammoth.transforms.getDescendantsOfType</code>.
<h4>FAQs</h4>
<a href="https://mike.zwobble.org/projects/mammoth/faqs/" rel="nofollow ugc">Answers to some frequently asked questions about Mammoth</a>.
<h3>Donations</h3>
If you’d like to say thanks, feel free to <a href="https://ko-fi.com/S6S01MG20" rel="nofollow ugc">make a donation through Ko-fi</a>.
If you use Mammoth as part of your business, please consider supporting the ongoing maintenance of Mammoth by <a href="https://liberapay.com/mwilliamson/donate" rel="nofollow ugc">making a weekly donation through Liberapay</a>.

Mammoth .docx converter

Mammoth converts semantically marked up .docx documents to simple and clean HTML, allowing pasting from Word documents and Google Docs without the usu …

avneetk

A simple file download widget for frontend interface. Lets your visitors download brochures etc.

File Download

A very simple and easy to use plugin for making anything out there and public for download.

Makes any file/image downloadable!

A simple file download widget for frontend interface. Lets your visitors download brochures etc.

Mammoth .docx converter vs File Download