How does FoldingText relate to Markdown
FoldingText is an outliner that uses Markdown based syntax to define the outline structure. Using Markdown based syntax can make FoldingText appear to be just another Markdown editor, but that’s not really what it is. At this core FoldingText is an outliner and has similar, but diverging goals when compared to a traditional Markdown editor.
Traditionally Markdown’s (and also Markdown editors) primary goal has been to allow you to create a document in readable plain text, and then to generate a final HTML document from that source text. With traditional Markdown the end goal is a finished HTML document.
FoldingText’s primary goal is to allow you to type in readable plain text to create an outliner structure, which you can then use to think and work. With FoldingText the primary goal is to create a place to work and think.
There’s lots of overlap, you can of course think and work in a traditional Markdown editor, and FoldingText can be used to create documents where the end goal is to export as HTML. But the different focuses mean that FoldingText’s recognized syntax diverges from standard Markdown syntax in a number of places, which are listed here:
Unrecognized Markdown Syntax
- FoldingText doesn’t syntax highlight other types (headers, lists, etc) embedded in blockquotes.
- FoldingText doesn’t syntax highlight block quotes embedded into list items.
- FoldingText doesn’t syntax highlight Setext-style headers–those that are “underlined” using equal signs (for first-level headers) and dashes (for second-level headers).
- FoldingText requires a space after last > in block quotes. (Markdown doesn’t require space)
- FoldingText requires that list items start with optional tabs followed by list character (-, *, or +). Markdown allows you to start them with 1-3 proceeding spaces.
- FoldingText requires that codeblocks use the leading four spaces syntax. Markdown standard also allows codeblocks to start with tabs, but FoldingText uses tabs for other purposes. (See Markdown Additions)
It should be noted that FoldingText can open and edit any plain text file. Including Markdown files with any of the above features. But they are unsupported in the sense that the outliner structure that FoldingText creates will be different in these cases then what standard Markdown would create.
Additional FoldingText Syntax
FoldingText extends Markdown syntax with new features that help make FoldingText a better place to think and organize information. I will just list the features here, see the users' guide for formatting information:
- FoldingText allows you to apply tags to any line.
- FoldingText allows you to create property lines.
- FoldingText allows you to assign a specific mode to part of your document using file extension syntax.
- FoldingText uses tab indentation to create outline structure in normal paragraphs.
- FoldingText support MultiMarkdown style definition lists.