u-blox
Overview
ReStructuredText Examples
Thingstream
Version latest

HTML Specs

Note
We are in the process of testing to accept html as a source - please only provide html if previously agreed upon
Note
This document is a work in progress and some of the details will change

Deliverables

The html needs to be provided in a single html.
Please do not add any JavaScript or CSS to the file. An image folder with images, that are used within the documentation, can be included.
The name of the html file can be choosen freely.
The name of the image folder has to be ‘images’.

repository
│   documentation.html  
│
└───images
│   │   image.jpg
│   │   image2.png
│   │   image3.gif
│   │

Structure

The html file needs and should have the following structure.
Text in all caps can be replace with custom values.

TITLE will be used as the title of the documentation in the left sidebar.

<html>
<head>
    <title>TITLE</title>
</head>
<body>

<section id="ID1">
<h1>SECTION_TITLE</h1> 

// SECTION BODY defintion see blow

</section>

</body>
</html>

The body can contain multiple sections, each section will become its own page

Section Body

The following elements can be used within the section body

Headlines

All headlines are always nested within the section body of the previous higher level headlines

h2

h2 headlines will appear in the right sidebar navigation

<section id="ID">
    <h2>
    TITLE
    </h2>
    
    // SECTION BODY

</section>

h3

<section id="ID">
    <h3>
    TITLE
    </h3>
    
    // SECTION BODY

</section>

h4

<section id="ID">
    <h4>
    TITLE
    </h4>
    
    // SECTION BODY

</section>

h5

<section id="ID">
    <h5>
    TITLE
    </h5>
    
    // SECTION BODY

</section>

Emphasis

Bold text

<strong>TEXT/strong>

Italic text

<em>TEXT</em>

Strikethrough text

<s>TEXT</s>

Blockquotes

<blockquote>
 //HTML
<blockquote>

Lists

Unordered lists

<ul>
<li>
    //HTML
</li>
<li> 
    //HTML
</li>
// MORE ITEMS
</ul>

Ordered lists

<ol>
<li>
    //HTML
</li>
<li> 
    //HTML
</li>
// MORE ITEMS
</ol>

Code

<pre>
  LINE_1
  LINE_2
  LINE_3
</pre>

Tables

The classes of the rows always alternate between ‘row-odd’ and ‘row-even’, starting with ‘row-odd’

<table class="docutils align-default">
  <thead>
    <tr class="row-odd">
      <th class="head"><p>TITLE</p></th>
      <th class="head"><p>TITLE 2</p></th>
      // MORE TABLE HEADERS
    </tr>
  </thead>
  <tbody>
    <tr class="row-even">
      <td>
        <p> 
          // HTML
        </p>
      </td>
      <td>
        <p> 
          // HTML
        </p>
      </td>
    </tr>
    <tr class="row-odd">
      // ROW CONTENT
    </tr>
      // MORE ROWS
    </tbody>
</table>

Images

All images need to placed in a folder named ‘images’. Images for the following types can be used: jpg, png and gif.

<img alt="ALT" src="RELATIVE_PATH" />