Reference Documentation

Complete technical reference for U.WIKI configuration and features.

Available References

• API Documentation - Complete API reference
• Configuration Options - All configuration settings

Configuration Quick Reference

Essential Settings

Setting	Description	Default
site_name	Name of your wiki	Required
site_url	URL where wiki is hosted	None
theme.name	Theme to use	material
theme.palette.primary	Primary color	indigo

Common Customizations

# Dark mode
theme:
  palette:
    - scheme: default
    - scheme: slate

# Search configuration  
plugins:
  - search:
      lang: en

# Navigation tabs
theme:
  features:
    - navigation.tabs

File Structure

U.WIKI/
├── mkdocs.yml          # Main configuration
├── docs/               # All content
│   └── index.md        # Home page
├── site/               # Generated HTML (git ignored)
└── requirements.txt    # Python dependencies

Markdown Extensions

Enabled by Default

• Admonitions - Note/warning boxes
• Code Highlighting - Syntax highlighting
• Tables - Markdown tables
• TOC - Table of contents
• Superfences - Advanced code blocks

Available Extensions

See Configuration Options for the complete list.

Command Reference

Development

# Start dev server
mkdocs serve

# Custom port
mkdocs serve -a localhost:8080

# Verbose output
mkdocs serve --verbose

Building

# Build site
mkdocs build

# Strict mode (fails on warnings)
mkdocs build --strict

# Clean build
mkdocs build --clean

Deployment

# Deploy to GitHub Pages
mkdocs gh-deploy

# Custom branch
mkdocs gh-deploy -b gh-pages

# Custom commit message
mkdocs gh-deploy -m "Update documentation"

Troubleshooting

Common Issues

Build Warnings

WARNING - Documentation file 'missing.md' does not exist

Solution: Check all links in navigation and content.

Theme Not Found

ERROR - Theme 'material' not found

Solution: Install missing theme:

pip install mkdocs-material

Port Already in Use

ERROR - Cannot bind to port 8000

Solution: Use a different port:

mkdocs serve -a localhost:8001

Environment Variables

Variable	Description	Example
SITE_NAME	Override site name	My Wiki
SITE_URL	Set site URL	https://wiki.example.com
ENABLE_ANALYTICS	Enable/disable analytics	true

Performance Tips

1. Optimize Images - Use appropriate formats and sizes
2. Limit Plugins - Only use necessary plugins
3. Clean Builds - Regularly clean build artifacts
4. CDN Usage - Serve static assets from CDN

Security Considerations

1. No Dynamic Content - Static sites are inherently secure
2. HTTPS Only - Always use HTTPS in production
3. Access Control - Implement at web server level
4. Regular Updates - Keep dependencies updated

API Integration

While U.WIKI generates static sites, you can integrate with APIs:

// In custom JavaScript
fetch('/api/search')
  .then(response => response.json())
  .then(data => {
    // Handle search results
  });

Extending U.WIKI

Custom Themes

1. Create theme directory
2. Extend Material theme
3. Override templates
4. Add custom CSS/JS

Plugins

1. Install MkDocs plugins
2. Configure in mkdocs.yml
3. Use plugin features

Hooks

# mkdocs_hooks.py
def on_pre_build(config):
    # Custom pre-build logic
    pass

Version Compatibility

Component	Minimum Version	Recommended
Python	3.8	3.11+
MkDocs	1.5.0	Latest
Material	9.0.0	Latest

Getting Help

• Check the FAQ
• Search existing issues
• Ask in discussions

Contributing

See our contribution guidelines to help improve U.WIKI.