html2commonmark icon indicating copy to clipboard operation
html2commonmark copied to clipboard

Setup instructions

Open azirbel opened this issue 8 years ago • 1 comments

Hi, and thank you so much for making this library! I just started using it and am already finding it really useful.

I have a couple cases where I'd like to add a configuration option to render different markdown output. I was going to try adding the features myself, but actually I'm not sure how to build html2commonmark and produce the dist/browser/bundle.js file so I can try it in my project.

Would you be able to add dev setup steps to the README?

Second question: do you plan to add a license for this library?

azirbel avatar Sep 21 '16 06:09 azirbel

Hi @azirbel, thanks for your response. glad you like the project!

A grunt build should do the trick. I should probably add an npm start command here. I haven't kept this project up-to-date with the latest developments on the commonmark spec. I'm not sure what your goal is, but to get a 100% correct and up-to-date transformation it might be smart to update the tests first. Please let me know if that is the case, than i can help you with instructions on doing that.

i will add the license file (apache 2).

nicojs avatar Sep 28 '16 19:09 nicojs