- 3. Creating a new project
3.4. File syntax - 3.3. Chapters
« Previous - 3.4.1. Introduction
Next »
3.4. File syntax
Table of Contents
- 3.4.1. Introduction
- 3.4.2. Paragraphs and text
- 3.4.3. Emphasis
- 3.4.4. Code spans
- 3.4.5. Headers
- 3.4.6. Links
- 3.4.7. Images
- 3.4.8. Lists
- 3.4.9. Code blocks
- 3.4.10. Tables
- 3.4.11. Definition lists
- 3.4.12. Footnotes
- 3.4.13. Blockquotes and information frames
- 3.4.14. Inline HTML
- 3.4.15. Advanced use
A sample chapter file looks like this:
Title: Some title
Option1: Some value
Option2: Some value
OptionList:
- value 1
- value 2
---
Chapter content
In the header section, we put the tags in the way showed above. The Title is compulsory, but TypeFriendly recognizes much more. In fact, their list depends on the used output, because usually it's it which makes use of them. You can easily create a new output and start to use your own tags. It will be described later.
The header must be separated from the content by at least three pause characters --- surrounded with two single empty lines.
The content is formatted using the "PHP Markdown Extra" syntax with some extensions and modifications. You can find it in many websites, because the parsers are simple in use and very popular, so there is a chance you already know it. However, whether you know it or not, we encourage you to take a look at our syntax description, to see what improvements have been introduced by TypeFriendly. Similar documents can be also found at the parser website mentioned above.
See also:
- 3.4. File syntax
3. Creating a new project - « Previous
3.3. Chapters - Next »
3.4.1. Introduction