When organizing a document using file numbers, it is possible to define a document's metadata using a YAML-formatted block (also known as a "front matter") in the root README.md file.
For example:
---
"author": ["John Doe", "Jane Doe"] # This is an example comment
"ft:title": "API Reference Guide"
"ft:originId": "api-guide"
"Product": "Fluid Topics"
"Category": "Guide"
"audience": "internal"
"ft:lang": "en-US"
"media_dir": "images"
---
| Metadata key | Required? | Value of the metadata key |
|---|---|---|
ft:title |
Yes | The title of the document. It is mandatory. |
ft:originId |
Yes | The document's unique identifier in Fluid Topics. |
ft:lang |
No | The document's language. Its default value is en-US. |
media_dir |
No | A folder that users can use to insert media files in the publication. Its default value is images.When embedding a media file, always use the file's relative path to specify its location. |
Topics inherit the audience metadata from the document. If a topic or a section of a public document is set to internal, it remains visible to everyone.