meteorlxy / vue-showdown

:page_with_curl: Use showdown as a vue component
https://vue-showdown.js.org
MIT License
129 stars 23 forks source link

Support extensions (documentation) #2

Closed moelders closed 5 years ago

moelders commented 5 years ago

Hello, I have been facing the showdown extensions using this plugin, and I think it is a good idea to update the documentation of this plugin. You can see my changes.

Changelog:

Pending tasks:

meteorlxy commented 5 years ago

@moelders Thanks for your PR! I'll check in detail later.

BTW, is it a good idea to have both package-lock.json and yarn.lock in a same repo?

moelders commented 5 years ago

As I do not use yarn I am not sure about the answer. If you prefer to rely on yarn I can remove the package-lock and add it to the .gitignore.

moelders commented 5 years ago

I have just reading this Yarn post about compatibility with package-lock from version 1.7.0.

But no problem, I can remove it and you can update yarn.lock.

meteorlxy commented 5 years ago

I didn't include extensions in the docs because I was lazy I thought extensions is also one of the property of options. But yeah it would be better to mention it in our docs, too.

I'll merge this PR after some tweaks and transilations. 😄

meteorlxy commented 5 years ago

@moelders

I've bumped vue-showdown to v2.2.0 with some breaking changes, which makes the usage of extensions different.

It will be nice if you have time to check them and give some suggestions. Thanks in advance 😄

moelders commented 5 years ago

Great @meteorlxy! I will check it in the next project update. Thanks!