Documents
Documents are the main object type in the Knowledge Manager Bot. They contain a title and a content.
Structure
Documents are structured inside of topics, but it is not necessary to place a document in a topic. They can also live outside of topics. Each topic is placed inside of a project.
This creates the following tree structure:
Project 1
└── Topic 1
└── Document 1
└── Document 2
└── Document 3
└── Topic 2
└── Document 4
└── Document 5
└── Document 6
Project 2
└── Topic 3
└── Document 7
└── Document 8
└── Document 9
Markdown formatting
Every Document content has multiple options for formatting. The formatting standard is Markdown, but not every feature is support.
Headings
You can structure your document by having 3 level of headings. Each Heading level is represented by a # at the beginning of the line.
# Heading 1
## Heading 2
### Heading 3
Bold
You can make text bold by surrounding it with **.
**Bold text**
Italic
You can make text italic by surrounding it with *.
*Italic text*
Bold and Italic
You can make text bold and italic by surrounding it with ***.
***Bold and italic text***
Links
You can add links to your document by surrounding the text you want to link with [ and ] and the link with ( and ).
[Link text](https://www.example.com)
Images
You can add images to your document by surrounding the alt text with [ and ] and the image URL with ( and ) and prefixing it with a !.
If you want to use images in a public document via Bnder pages, the image needs to be served via our CDN. To do so, you can upload the image to the File storage and make it public. Then copy the public URL and use it in your document.
Commands
Create a document
Read a document
Get Document info
List all documents
Edit a document
Delete a document
Restore a document
Change the topic of a document