Skip to content

Latest commit

 

History

History
128 lines (116 loc) · 5.56 KB

README.md

File metadata and controls

128 lines (116 loc) · 5.56 KB

Documentation

Welcome to the Exolynk system documentation.

Important Note: the Exolynk Documentation CMS used some specific tags and syntaxes which are described here some of them will not be rendered as a proper Markup on GitHub, please use therefore our Exolynk Documentation CMS.

Navigation


Little helper to generate md Navigation

https://github.com/michalbe/md-file-tree

Dependencies: tree

Installation under MacOS: brew install tree


File Structure for Documentation CSM

└── pages
    ├── 01.Use-of-exolynk
    │   ├── 01.getting-started
    │   │   └── exolynk.md
    │   ├── 02.configuration
    │   │   └── exolynk.md
    │   └── chapter.md

Instruction

  1. For each document (*.md file) a separate folder is neccesary
  2. The folder has to be named as following: ORDER#. (two digits) FILENAME (lowercase) Example: 01. getting-started
  3. The File name needs to be allways exolynk.md (twig-template)
  4. The file title is specified in the document header as following:
---
title: 'Getting started'
taxonomy:
    category: docs
process:
    twig: true
---