This repository contains the documentation for external use. status 2020-01-30: Proof of Concept to see if we want to go the direction of git/markdown/custom rendering
Simply go to the documentation start page :)
Writing markdown in git allows us to have a versioned documentation base that can be used in various forms (e.g. the view in github, but also the rendering in our website style as well as integration in whitelabeled distributions of our platform)
Have a look at this cheatsheet to get a grip on markdown.
Editing markdown is easy in Visual Studio Code, simply give the file an extension .md and it will be recognised as Markdown and activate markdown support, also allowing you to have the preview.
There are quite a bit shortcuts available (e.g. to make selected text bold, to add a link to selected text, ...)
Add the image file to the folder _media_
In the page you want to use the image, add
. Pick the one you want to show.
To easily create consistent browser screenshots, there is a automated service available for Mac. Have a look here how it works and contact Toon for more info.
There is a plugin active on our confluence that exports the page as markdown. From a page, click the ... and select Export to Markdown in the drop-down menu. Copy the file content in VCS for further editing.
[] limit the width of the page content (now taking the full width, readability not being top)