- use .mdx as filename ending in GitHub
- After you have inserted a new page, add it to the TOC (table of contents) so that it will be visible on the page.
- Insert at the top of every page:
id: The unique document id. By default, a document id is the name of the document (without the extension) relative to the root docs directory. It can be used in the left TOC.
sidebar_label: Name displayed in the table of content (TOC).
slug: Optional. Defines the last part of the URL.
title: Optional. Prompted on the page.
For icon buttons the library Font Awesome is used. Get icons from here: https://fontawesome.com/ and import them in the page together with a button function. The color palette is from the Infima library.
You can change the size of a button in its style attribute with values in %, pixel (px), rem or em.
To create a heading, add number signs # in front of a word or phrase. The number of # you use should correspond to the heading level. A lot of # indicates a low level.
Images can be inserted as Markdown or as HTML for special configurations (resizing etc.) or if the image is inside an HTML tag:
There should be no /static in src.
Insert two white spaces at the end of the line.
link to another page in the docu:
link to another chapter in the same page with the last segement of the URL:
e. g. URL: eln.chemotion.net/chemotionsaurus/docs/instructions #toc
random number with a dot
highlight elements, e. g. UI elements
The TOC on the left of every documentation page must be manual updated via sidebars.js on GitHub. If you have inserted a new page or want to change the order, change it here.