maettu / qx-showdown Goto Github PK

Hi, thanks for this package.

I am using it in the Package Browser to display the readmes of the packages, see, for example, the readme for this project.

May I suggest the following changes?

• Load the showdown library as an external resource instead of inline in the class: this prevents the recompilation of the code by the compiler (and error messages that are thrown). You can download the showdown minified file of your choice and then qx add script <path/to/script> to add it to the project, which will copy it to the resource folder and make an entry into the Manifest.json file. It will also be easier to maintain - just replace the external resource with a newer version without touching the qx class.
• Wrap the showdow methods with methods of the qx class so that they can be nicely documented and displayed in the API viewer.

I think these changes would make then package even more qooxdoo'ish ...

I'd be happy if you find these suggestions useful.