Skip to content

TheSwanFactory/html-to-maml

Repository files navigation

html-to-maml

html-to-maml is a simple tool for converting HTML tags into MAML documents. It is built on himalaya, and therefore does not convert script or style tags.

Using this module in other modules

Here is a quick example of how this module can be used in other modules. The TypeScript Module Resolution Logic makes it quite easy. The file src/index.ts acts as an aggregator of all the functionality in this module. It imports from other files and re-exports to provide a unified interface for this module. The package.json file contains main attribute that points to the generated lib/index.js file and typings attribute that points to the generated lib/index.d.ts file.

If you are planning to have code in multiple files (which is quite natural for a NodeJS module) that users can import, make sure you update src/index.ts file appropriately.

We will published this module to npm with the name html-to-maml, so you can install it using npm install -s html-to-maml. Then, in your code:

  • To use html-to-maml in a TypeScript file -
import { html-to-maml } from "html-to-maml";

const maml = html-to-maml("<p>Hello, MAML!</p>");
  • To use the Mamlify class in a JavaScript file -
const html-to-maml = require('html-to-maml').Mamlify;

const maml = html-to-maml("<p>Hello, MAML!</p>");

About

Convert HTML and SVG markup into MAML documents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published