defuddle 0.3.0 → 0.3.2

package/README.md

@@ -34,6 +34,21 @@ console.log(article.content);  // HTML string of the main content
 console.log(article.title);    // Title of the article
 ```
 
+### Bundles
+
+Defuddle comes in two bundles:
+
+**Core bundle** (~50kB), no dependencies
+```js
+import { Defuddle } from 'defuddle';
+```
+**Full bundle** (~432kB), includes advanced math conversion capabilities
+```js
+import { Defuddle } from 'defuddle/full';
+```
+
+The core bundle is recommended for most use cases. It still handles math content, but doesn't include fallbacks for converting between MathML and LaTeX formats. The full bundle adds the ability to create reliable `<math>` elements using `mathml-to-latex` and `temml` libraries.
+
 ### Debug mode
 
 You can enable debug mode by passing an options object when creating a new Defuddle instance:
@@ -91,11 +106,13 @@ Defuddle attempts to standardize HTML elements to provide a consistent input for
 
 ### Headings
 
-Anchor links in `<h1>` to `<h6>` elements are removed and become plain headings.
+- The first H1 or H2 heading is removed if it matches the title.
+- H1s are converted to H2s.
+- Anchor links in H1 to H6 elements are removed and become plain headings.
 
 ### Code blocks
 
-Code block are standardized to the following output. If present, line numbers and syntax highlighting are removed, but the language is retained and added as a data attribute and class.
+Code block are standardized. If present, line numbers and syntax highlighting are removed, but the language is retained and added as a data attribute and class.
 
 ```html
 <pre>
@@ -123,6 +140,18 @@ Inline reference<sup id="fnref:1"><a href="#fn:1">1</a></sup>.
 </div>
 ```
 
+### Math
+
+Math elements, including MathJax and KaTeX, are converted to standard MathML:
+
+```html
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="inline" data-latex="a \neq 0">
+  <mi>a</mi>
+  <mo>≠</mo>
+  <mn>0</mn>
+</math>
+```
+
 ## Development
 
 ### Build

package/dist/index.full.d.ts

@@ -0,0 +1,3 @@
+import { Defuddle } from './defuddle';
+import { DefuddleOptions, DefuddleResponse } from './types';
+export { Defuddle, DefuddleOptions, DefuddleResponse };