README

PDFIm Autor öffnen

Electra Documentation Author

Technical documentation that just works

About

The Documentation Author is a comfortable platform to create and share documentation, tasks or tutorials with others. It is possible to create formatted text or circuits and to organize them into chapters.

As already mentioned, the basis for this is the formatting language Markdown

What's Markdown?

Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. Created by John Gruber in 2004, Markdown is now one of the world’s most popular markup languages.

Using Markdown is different than using a WYSIWYG editor. In an application like Microsoft Word, you click buttons to format words and phrases, and the changes are visible immediately. Markdown isn’t like that. When you create a Markdown-formatted file, you add Markdown syntax to the text to indicate which words and phrases should look different.

Markdown quick reference

Double-click on this page to see how the formating happends

h1 Heading

h2 Heading

h3 Heading

h4 Heading
h5 Heading
h6 Heading

Emphasis

This is bold text

This is bold text

This is italic text

This is italic text

Strikethrough

Lists

Unordered

  • Create a list by starting a line with ++, −-, or ⋅\cdot
  • Sub-lists are made by indenting 2 spaces:
    • Marker character change forces new list start:
      • Ac tristique libero volutpat at
      • Facilisis in pretium nisl aliquet
      • Nulla volutpat aliquam velit
  • Very easy!

Ordered

  1. Lorem ipsum dolor sit amet

  2. Consectetur adipiscing elit

  3. Integer molestie lorem at massa

  4. You can use sequential numbers...

  5. ...or keep all the numbers as 1.{1}.

Start numbering with offset:

  1. foo
  2. bar

Code

Inline code{c}{o}{d}{e}

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code

Block code "fences"

Sample text here...

Tables

Option Description
data path to data files to supply the data that will be passed into templates.
engine engine to be used for processing templates. Handlebars is the default.
ext extension to be used for dest files.

Right aligned columns

Option Description
data path to data files to supply the data that will be passed into templates.
engine engine to be used for processing templates. Handlebars is the default.
ext extension to be used for dest files.

Links

link text

link with title

Mathematic

blocked

x=∑sin(x2)⋅tan(x)2{x}=\sum\frac{{{\sin{{\left({x}^{{2}}\right)}}}\cdot{\tan{{\left({x}\right)}}}}}{{2}}

inline

It is possible to add formulars like x=∑(x−4){x}=\sum{\left({x}-{4}\right)} even in inline mode.