This directory contains the Robot Framework HTML frontend for libdoc. Eventually, also log and report will be moved to the same tech stack.
This prototype uses following technologies:
- Parcel is used to create development and (minified) shipping bundles. It offers a very low-configuration way of creating standalone HTML files, which contain all the code and styles inlined.
- Typescript is used to write the business logic. It offers better development ergomonics than plain Javascript.
- Handlebars is used for templating. Using either HTML
<template>tags + code, or generating HTML purely from code were also considered. However, a template system makes authoring complex HTML much simpler, since creating nested structures purely in code leads to hard-to-maintain solutions almost inevitably. Handlebars enables re-use of existing templates with minor modifications, while it offers some new feature that help e.g. with localisation.
Unit test are written using Jest.
Install dependencies:
npm install
Run:
npm run start
The development server starts at localhost:1234.
Test:
npm test
Prettier is used to format code, and it can be run manually by:
npm run pretty
The static text in the libdoc HTML can be localised to different languages. The created documentation contains a language selector that can be used to select the current localisation. There is also command line option in the libdoc cli to set the default language.
To create new localisations, edit the translations file. It is as easy as adding a new element to the top level object by copying, for example the contents of the "en" key.