The Markdown connector can transform Markdown files into a Fluid Topics publication by following the numbering of files and folders, and ordering them accordingly.
In this situation, publications must contain a root README.md file. It contains the publication's metadata, and can contain text. See Root README.md file.
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 # Title: A test README.md document
- 01_introduction.md # Title: Introduction
- 02_chapter1/
- README.md # Title: First folder root topic
- 01_topic.md # Title: Lorem
- 02_topic.md # Title: Ipsum
- 03_chapter2/
- README.md # Title: Another folder root topic
- 01_topic.md # Title: Dolor
- 02_topic.md # Title: Sit
- 03_topic.md # Title: Amet
- 04_conclusion.md # Title: Conclusion
This file produces a document with the following table of contents:
A test README.md document
1. Introduction
2. First folder root topic
a. Lorem
b. Ipsum
3. Another folder root topic
a. Dolor
a. Sit
a. Amet
4. Conclusion
The headers of the Markdown files create subtopics. It it not possible to choose whether the Markdown files headers create subtopics.
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.