https://github.com/wirecloud/markdown-viewer-widget

Markdown viewer widget for WireCloud
https://github.com/wirecloud/markdown-viewer-widget

wirecloud-component wirecloud-widget

Last synced: 26 days ago
JSON representation

Markdown viewer widget for WireCloud

• Host: GitHub
• URL: https://github.com/wirecloud/markdown-viewer-widget
• Owner: Wirecloud
• License: apache-2.0
• Created: 2017-02-24T10:23:44.000Z (over 9 years ago)
• Default Branch: develop
• Last Pushed: 2019-04-02T18:16:45.000Z (over 7 years ago)
• Last Synced: 2025-10-29T15:52:07.458Z (9 months ago)
• Topics: wirecloud-component, wirecloud-widget
• Language: JavaScript
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Markdown viewer widget

[![](https://nexus.lab.fiware.org/repository/raw/public/badges/chapters/visualization.svg)](https://www.fiware.org/developers/catalogue/)

![](https://img.shields.io/github/license/Wirecloud/markdown-viewer-widget.svg)

The Markdown viewer widget is a [WireCloud widget](http://wirecloud.readthedocs.org/en/latest/) 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](http://node.js) and [Bower](http://bower.io) in your system. For example, you can

install it on Ubuntu and Debian running the following commands:

```console

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)

```console

sudo npm install

```

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

```console

sudo npm install -g grunt-cli

```

And now, you can use grunt:

```console

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](src/doc/userguide.md). Anyway, you can find

general information about how to use widgets on the

[WireCloud's User Guide](https://wirecloud.readthedocs.io/en/stable/user_guide/) available on Read the Docs.

## Copyright and License

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