kbss-cvut / termit-web

TermIt web

Web theme is based on the Minimal Mistakes Jekyll theme under the MIT License, using Jekyll.

Web describes the basic features of TermIt and basic information about its authors. It contains following sections:

• About - Basic information about,
• Install - step-by-step installation process,
• Tutorial - description of the basic usage scenarios,
• Deployments - description and links to current deployments,
• Data model - description of existing data models.

Changes

It is necessary to follow some rules during the content creation.

• Create new branch to push changes.
• For each section is created a .md file in [_pages][_pages]. Feel free to create any content, but do not change the header (between --- lines).
• Locate images used in every section in the designated folder in [assets/images][assets/images].

For including images use:

{% include figure image_path="/assets/images/image.jpg" alt="this is a placeholder image" caption="This is a figure caption." %}

Do not change anything else than content of [_pages][_pages] and [assets/images][assets/images]

In the first section - Quick-start guide, you can find help. We must remove it before it is done.

termit-web's Issues

Move deployments to about page

Current deployments page shall be moved to about as User reviews.
It shall also contain live demo from https://kbss.felk.cvut.cz/termit-demo/

Complete Data models

Rename section to Technical Details. It shall contain:

• data models (@MichalMed)
• more? suggest

Fill in the installation page

It shall include instructions to download TermIt, install through docker and install by building source.

Rozšíření dokumentace

V nové sekci Dokumentace se nachází dokumentace jednotlivých featur formou postů. Zatím tam je pouze snapshot, chtělo by to rozšířit o další featury. Namátkou:

Detail slovníku, detail pojmu, záložka slovníky, zdroje, anotace, editace pojmu, editace slovníku....

Create page with technical information about TermIt

It should contain:

• Basic technologies
• Architecture
• Info about custom libraries we use

Documentation of snapshots

Add documentation of the snapshots feature.