Skip to main content
Article Files: content/docs/*.mdx
Category Icons? Learn how to configure icons for categories and content blocks in the Icons Guide.

What is Knowledge Base?

The Knowledge Base is a self-service help center where customers can find answers to common questions without contacting support. It includes:
  • Searchable articles - Full-text search functionality
  • Category organization - Group articles by topic
  • Rich content blocks - Text, images, code, videos, alerts
  • SEO optimized - Each article has its own URL and meta tags
  • Mobile responsive - Perfect on all devices
Benefits:
  • Reduce support tickets by 60-80%
  • 24/7 help for customers
  • Improve SEO with quality content
  • Build customer trust and confidence

Creating Article

1

Copy the Template

Navigate to config/knowledgebase/articles/ and copy the template:
Naming convention:
  • Use lowercase
  • Use hyphens, not spaces
  • Be descriptive
  • Examples: setup-minecraft-server.ts, how-to-upload-world.ts
2

Fill in Details

Open your new file and update the metadata:
3

Add Content Blocks

Write your article using content blocks (detailed below):
4

Register your Article

Open config/knowledgebase/index.ts and add:
5

Test your article

Visit your development site:
Check:
  • Article displays correctly
  • Images load
  • Code blocks have copy buttons
  • Search finds your article
  • Category filter works

Content Blocks Reference

Paragraph

Regular text with optional bold formatting:
Markdown support in paragraphs:
  • **bold**bold
  • Plain text (no italic support yet)

Headings

Create section headers:
Best practices:
  • Use H1 only once (main title)
  • Use H2 for major sections
  • Maintain hierarchy (don’t skip levels)

Code Blocks

Syntax-highlighted code with copy button:
Supported languages:
  • bash - Terminal commands
  • javascript / js - JavaScript
  • typescript / ts - TypeScript
  • python - Python
  • java - Java
  • json - JSON
  • yaml - YAML
  • properties - Config files
  • css - CSS
  • html - HTML
  • sql - SQL
Examples:

Images

Add images with captions:
Image best practices:
  1. File location: Save in public/images/kb/
  2. Naming: Use descriptive names: minecraft-setup-step1.png
  3. Format: PNG or JPG
  4. Size:
    • Maximum width: 1200px
    • Compress with TinyPNG
    • Target: Under 200KB per image
  5. Alt text: Describe the image for accessibility
Example structure:

YouTube Videos

Embed YouTube videos:
How to get Video ID:
  • From URL: https://www.youtube.com/watch?v=dQw4w9WgXcQ
  • Video ID is: dQw4w9WgXcQ

Alert Box

Highlight important information:

Categories

Organize articles by category: Add a category: Edit config/knowledgebase/index.ts:

Page Configuration

Customize the knowledge base landing page appearance and content.
Config File: config/pages/knowledgebase.ts

Hero Section

Configure the main header area with search:
Options: Visual Example: The hero displays as: “How Can We Help You?” where “Help You” is in your brand color. Showcase top articles on the main page:
Options:
Popular articles are taken from the first N articles in your articles array. Manually reorder articles in config/knowledgebase/index.ts to control which appear.

Categories Section

Control category filter buttons:
Options:
When categories are disabled, users can only browse all articles or use search. Consider keeping this enabled for better UX.

Articles Section

Configure article listings and empty states:
Options:

Help CTA Section

Bottom call-to-action for support:
Options: Button Object:
Primary buttons use your brand color. Non-primary buttons have a secondary gray style. External links (Discord, etc.) automatically open in new tabs.

Complete Configuration Example

Styling & Theming

The knowledge base automatically uses your brand color from config/branding.ts.

Automatic Brand Color Integration

All interactive elements automatically adapt to your brand color:
  • Search bar focus state
  • Category filter buttons (when selected)
  • Popular article cards borders and backgrounds
  • Call-to-action buttons (primary)
  • Article category badges
  • Link hover states
Example:
No additional styling configuration needed! Change your brand color once and the entire knowledge base updates automatically.

Content Block Styling

All content blocks have consistent spacing:

Responsive Design

The knowledge base is fully responsive: Mobile (< 640px):
  • Single column article grid
  • Horizontal scrolling categories
  • Reduced text sizes
  • Touch-optimized buttons
Tablet (640px - 1024px):
  • 2-column article grid
  • All features visible
  • Medium text sizes
Desktop (> 1024px):
  • 3-column article grid
  • Full feature set
  • Large text sizes

SEO Optimization

Per-Article SEO

Each article automatically generates:

Best SEO Practices

  1. Title Optimization:
    • Keep under 60 characters
    • Include target keyword
    • Be descriptive and unique
    • Example: “How to Setup Minecraft Server in 5 Minutes”
  2. Description Optimization:
    • 120-160 characters
    • Include main keyword
    • Compelling summary
    • Example: “Step-by-step guide to setting up your Minecraft server with automatic backups and DDoS protection in under 5 minutes.”
  3. Tag Strategy:
    • 3-7 tags per article
    • Mix of specific and general
    • Use lowercase
    • Example: ["minecraft", "setup", "beginner", "tutorial", "java-edition"]
  4. Content Structure:
    • Use proper heading hierarchy (H1 → H2 → H3)
    • Include alt text for all images
    • Add captions to images and videos
    • Break up long paragraphs
  5. Internal Linking:
    • Link to related articles in content
    • Use descriptive anchor text
    • Example: “Learn about server backups

Search Functionality

How Search Works

The built-in search indexes:
  • Article titles (highest weight)
  • Article descriptions (medium weight)
  • Article tags (medium weight)
  • Category names (low weight)
Search features:
  • Real-time results as you type
  • Case-insensitive matching
  • Partial word matching
  • Can combine with category filters

Search Algorithm

Articles are ranked by total points and displayed in order.

Best Practices

Article Writing

Good:
  • “How to Setup a Minecraft Server”
  • “Fixing Connection Timeout Errors”
  • “Understanding Server Resource Usage”
Bad:
  • “Minecraft”
  • “Problems”
  • “Resources”
Begin every article with:
  1. What the article covers
  2. Who it’s for (beginner/advanced)
  3. Estimated time to complete
  4. Any prerequisites
  • Add screenshots for complex steps
  • Use alert boxes to highlight warnings
  • Include code blocks with examples
  • Embed tutorial videos when available
Rule of thumb: One image or code block per 200-300 words.
Before publishing:
  1. Follow your own instructions
  2. Have a beginner test them
  3. Note any confusing steps
  4. Add clarifications
Common issues:
  • Assuming knowledge (explain acronyms)
  • Skipping “obvious” steps
  • Not mentioning where to find things
  • Missing error handling instructions
  • Add “Last updated” in article metadata
  • Review articles quarterly
  • Update screenshots when UI changes
  • Archive outdated articles (don’t delete)

Content Organization

Article Structure Template:

Performance Tips

  1. Optimize Images:
    • Use WebP format when possible
    • Compress before uploading (target under 200KB)
    • Use appropriate dimensions (max 1200px width)
    • Lazy loading is automatic
  2. Limit Article Count:
    • Start with 10-15 quality articles
    • Add more based on actual customer questions
    • Don’t create articles “just because”
  3. Code Block Length:
    • Keep under 50 lines
    • For longer code, link to external repo
    • Use comments to explain complex parts
  4. Video Embedding:
    • YouTube embeds are lightweight
    • Prefer embedding over hosting
    • Keep videos under 10 minutes
    • Add timestamps in caption

Troubleshooting

Check:
  1. Article is exported correctly: export const article = {...}
  2. Article is imported in index.ts
  3. Article is added to articles array
  4. File has .ts extension
  5. No TypeScript errors (npm run build)
Solutions:
  1. Verify image path starts with /
  2. Check file exists in public/ folder
  3. Image names are case-sensitive
  4. Try clearing Next.js cache:
Reasons:
  1. Article title/description too different from search term
  2. Missing relevant tags
  3. Category filter active
Fix: Add more descriptive tags and improve title/description.
Check:
  1. Language is supported (see Content Blocks section)
  2. Language name is lowercase
  3. Code is properly escaped in TypeScript string
Common causes:
  1. Brand color not set in config/branding.ts
  2. CSS cache issue - hard refresh (Ctrl+Shift+R)
  3. Custom CSS conflicting
Solution:

Advanced Features

While lists support bold text, you can also include article links:

Multi-Language Support

Multi-language support is not built-in. Consider these approaches:
Option 1: Separate Article Files
Option 2: Use External Service
  • Integrate with i18n library
  • Use Crowdin/Lokalise for translations
  • Requires custom code modifications

Analytics Integration

Track knowledge base usage:

Custom Content Blocks

Want a custom block type? Extend the system:
1

Add to Type Definition

Edit config/knowledgebase/types.ts:
2

Create Renderer Component

Edit components/knowledgebase/ContentRenderer.tsx:
3

Use in Articles

Quick Reference

File Locations

Common Commands

TypeScript Types


Need Help?

Check out the FAQ or join our Discord community for support!