Skip to content
This repository has been archived by the owner on Oct 28, 2019. It is now read-only.

retest/retest-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation moved to: https://github.com/retest/docs

retest-docs

This is the documentation of retest, which can be found at https://retest.de/docs/.

Contributing

You are invited to correct errors or improve the documentation otherwise. In order to do so, open an issue or create a pull request. In the latter case, please follow the GitHub Flow guidelines and hard wrap lines at column 120. Furthermore, you must sign the contributor license agreement.

Modifying an Existing Page

Go ahead... .

How to Reference Icons, Images and Pages

Icons are placed inside /icons. Standard Markdown image reference can be used: ![Warning](icons/warning.png). Images are usually placed inside the pages' directory.

References to other pages are addressed with relative paths. They address the Markdown page: [english site](en/index.md).

Creating a New Page

When creating a new page, it should be placed inside a corresponding folder or a new folder should be created.

A new page should have the following template:

{% extends "${TEMPLATE}.tmpl" %}
{% block primary %}

[Here goes your content]

{% endblock primary %}

The ${TEMPLATE} should be replace according to the name of the .tmpl file inside the folder where the page was created. If there is no such file then the parent .tmpl file should be used (e.g de-docs-content.tmpl).

Each file should be listed inside the corresponding index.md file, so that readers can navigate to the page. If necessary, it should also be listed in the language root index.md (e.g de/index.md).