Markdown viewer widget

The Markdown viewer widget is a WireCloud widget that provides the ability to display markdown formatted texts. Example usage of this widget could be to display a "readme" for a workspace so other users can understand the dashboard.

Build

Be sure to have installed Node.js and Bower in your system. For example, you can install it on Ubuntu and Debian running the following commands:

curl -sL https://deb.nodesource.com/setup | sudo bash -
sudo apt-get install nodejs
sudo apt-get install npm
sudo npm install -g bower

Install other npm dependencies by running: (need root because some libraries use applications, check package.json before to be sure)

sudo npm install

In order to build this widget you need to download grunt:

sudo npm install -g grunt-cli

And now, you can use grunt:

grunt

If everything goes well, you will find a wgt file in the dist folder.

Documentation

Documentation about how to use this widget is available on the User Guide. Anyway, you can find general information about how to use widgets on the WireCloud's User Guide available on Read the Docs.

Copyright and License

Copyright (c) 2017 CoNWeT Licensed under the Apache-2.0 license.