You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
Matt Huntington 36dd2c0ea4
initial readme
10 years ago
README.mkd initial readme 10 years ago
index.js no longer need fs 10 years ago
package.json removing old dev dependencies 10 years ago

README.mkd

CML To HTML Converter

What is CML?

Check out the spec!

What does this library do?

This NPM library is just a single function that implements the CML spec by converting a string of CML into HTML.

How do I use it?

  • Install it using NPM: npm install cml-html-converter
  • require it the module, then call it.
	var exampleCMLString = 
		'item one of root list\n' +
		'\titem one of 1st nested list\n' +
		'\t\titem one of 2nd nested list\n' +
		'\titem two of 1st nested list'
	var converter = require('cml-html-converter');
	var htmlString = converter(exampleCMLString); 
  • in the example above htmlString should look something like this:
<ul>
	<li>
		item one of root list
		<ul>
			<li>
				item two of 1st nested list
				<ul>
					<li>
						item one of 2nd nested list
					</li>
				</ul>
			</li>
			<li>
				item two of 1st nested list
			</li>
		</ul>
	</li>
</ul>