Documentation Overview

How to setup the documentation

HTML Examples

Markdown Examples

ReStructuredText Examples

LEXI-R10 Series

Thingstream

u-Locate

Test POS

Images and Figures

1. Inline images

To add an image, add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title in quotation marks after the path or URL.

Example 1

Markdown:

Default

![Drone](images/drone_1536x1152.jpg)

Rendered Output:

Example 2

Markdown:

Default

![Mobility](images/Internal-mobility.png "Mobility")

Rendered Output:

Images can also be added by using a html image tag Markdown:

Default

<img src="images/drone_1536x1152.jpg" alt="Drone" />

Rendered Output:

Like links, Images also have a footnote style syntax

Default

![Alt text][id]

With a reference later in the document defining the URL location:

Default

[id]: images/organization.jpg  "Organization"

Rendered Output: ![Alt text][id] [id]: images/organization.jpg “Organization”

2. Base64 encoded Image

Instead of an url you can also add a base64 encoded image.

Markdown:

Default

<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...g==" alt="Update notification">

Rendered Output:

Markdown:

Default

![Hello World](data:image/png;base64,iVBORw0KGgoAAAANSUh...g==)

Rendered Output:

Markdown:

Default

![GPIO pin](data:image/svg+xml;base64...)

Rendered Output:

3. GIFs

Markdown:

Default

![gif test](images/dev-map-display-radius.gif)

4. Figures (images with captions)

Markdown:

Default

```{figure} images/organization.jpg
:scale: 50 %
:alt: map to buried treasure

This is the caption of the figure (a simple paragraph).

The legend consists of all elements after the caption.  In this
case, the legend consists of this paragraph and the following
table:

| Symbol | Meaning |
| ------ | ------- |
| test | description   |

```

Rendered Output: