Getting Started Guide#

Welcome! This guide will help you understand how to create and manage documents in the knowledgebase.

Document Structure#

Every document should start with YAML frontmatter:

Visibility Levels#

Choose the appropriate visibility for your document:

• public: Anyone can view
• authenticated: Only logged-in users
• groups: Specific user groups (requires groups: ["group1", "group2"])
• link: Anyone with the token (requires linkToken: "secret")
• invite: Anyone with invite tokens (requires inviteTokens: ["token1"])

Writing Content#

Use standard markdown syntax:

Headings#

Use # for headings (H1 through H6)

Emphasis#

• italic or italic
• bold or bold
• bold and italic
• strikethrough

Links#

Link text

Images#

Code#

Inline code or code blocks with syntax highlighting.

Best Practices#

1. Use descriptive titles - Make it easy to find documents
2. Add appropriate tags - Help with categorization and search
3. Set correct visibility - Protect sensitive information
4. Keep content updated - Update the updatedAt field when making changes
5. Use clear headings - Make documents easy to scan

Editing Documents#

You can edit documents in several ways:

1. Via WebDAV - Mount the server and edit with your favorite editor
2. Web UI - Use the built-in markdown editor (coming soon)
3. API - Programmatically update documents via the REST API

Need Help?#

Check out the other guides in this knowledgebase for more information!