Skip to content
Microshare Documentation Site
Branch: master
Clone or download
Latest commit d3a2e9d May 13, 2019

README.md

Microshare Documentation Site

Get started with Microshare, the world's only prebuilt, scalable data management and sharing solution for IoT.

Contribute to this documentation

This documentation is built with Jekyll and hosted on GitHub Pages at https://microshare.github.io.

Writing new articles

The documentation articles are written in Markdown, and you can find the files in the docs folder. Documents are arranged according to version. You will usually wish to contribute to the highest numbered version.

A Markdown editor is recommended for easiest contribution. Many Markdown editors will provide a WYSIWYG representation so you can ignore the details of Markdown notation.

To add a new article, head to _data/docs.yml and add the title of the article. Then create a file with the same title in the desired folder in the docs folder.

Add Images

Use the _includes/image.html helper to add images to your content, simply add in your .md file:

{% include image.html url="/assets/img/banner.jpg" description="Banner" %}

And replace the url with the path to your image (usually in the /assets/img folder) and add a description.

If needed, you can set the width of your image with the width parameter, for example:

{% include image.html url="/assets/img/banner.jpg" description="Banner" width="250px" %}

Add Code Snippets

Syntax highlighting of code snippets is supported using Rouge. To include a code snippet, just use the dedicated tag as below:

{% highlight http %}
  POST /share/:recType HTTP/1.1
  Host: api.microshare.io
  Content-Type: application/json
  Authorization: Bearer {{token}}
  {
    "hello": "world"
  }
{% endhighlight %}

A list of tags and supported languages is available at List of supported languages and lexers

Running the site locally

It is not necessary to run the site locally in order to contribute updates to the documents, but it may be useful for larger contributions.

If you have ruby installed you can install Jekyll withgem install jekyll bundler

Clone this repo to your local disk. Open a terminal and cd into the repo directory.

Run with bundle exec jekyll serve

Once Jekyll is running, the site can be visited at http://localhost:4000

For complete instructions on how to run Jekyll locally, by follow the Jekyll Installation and Jekyll Quick Start documents.

You can’t perform that action at this time.