File organization - Fluid Topics - Latest

Markdown Connector Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

The Markdown connector transforms Markdown files into a Fluid Topics publication by following the numbering of files and folders, and ordering them in a table of contents accordingly.

All publications must contain a root README.md file. It contains the publication's metadata, and can contain text.

Users can use folders as chapters for a publication. Each chapter must contain a README.md file. It is the first topic of a chapter.

Example of an archive:

README.md
01_introduction.md
02_chapter1/
  README.md
  01_topic.md
  02_topic.md
03_chapter2/
  README.md
  01_topic.md
  02_topic.md
  03_topic.md
04_conclusion.md

It is possible to create a document from a single root README.md file by using multiple heading levels. The Markdown connector then generates a table of contents based on the headers. Select the Attachments tab in the sidebar to download the README_template.md template.