Features

OkiDoki is an open source documentation generator designed for developers who want powerful documentation without complexity. Built by the community for the community, it’s free forever with no vendor lock-in. Here are the top 7 features that make it essential:

1. Markdown First: Write standard markdown with no proprietary formats
2. Dynamic Variables: Inject dynamic content with global and local variables
3. Tabs, Badges and Alerts: Rich interactive components for enhanced documentation
4. Auto Light/Dark Themes: Beautiful themes powered by Tailwind CSS and DaisyUI
5. Full-Text Search: Instant search across all documentation
6. SEO Optimization: Built-in features for better discoverability
7. Host Anywhere: Deploy anywhere static files are supported

1. Markdown First

Write in standard markdown - no proprietary formats or vendor lock-in:

# Your Documentation
Just write **normal markdown** with `code blocks`, tables, and links.

- No learning curve
- Use any markdown editor
- Version control friendly

Benefits: Focus on content, not syntax. Your documentation remains portable and future-proof.

2. Dynamic Variables

Inject dynamic content with global and local variables:

Global Variables (okidoki.yaml)

site:
  title: MyDocs
globals:
  version: "2.1.0"
  api_url: "https://api.example.com"
  company: "Acme Corp"

Local Variables

---
title: "API Guide"
author: "John Doe"
updated: "2024-01-15"
---

#  v1.0.40
Built by {{author}} for {{globals.company}}
Updated: {{updated}}

Benefits: Keep documentation up-to-date automatically. Change once, update everywhere.

3. Tabs, Badges and Alerts

Rich interactive components enhance your documentation with tabs, badges, and alerts - all using the simple Handlebars syntax:

Tabs

{{#tabs}}
    {{#tab title="JavaScript"}}
    ```js
    const api = new ApiClient('');
    console.log('Ready ...')
    ```
    {{/tab}}

    {{#tab title="Python"}}
    ```python
    api = ApiClient('')
    print('Ready ...')
    ```
    {{/tab}}
{{/tabs}}

const api = new ApiClient('');
console.log('Ready ...')

api = ApiClient('')
print('Ready ...')

Badges and Alert Messages coolfeature

Badges

User API {{badge "GET" "primary"}} {{badge "Stable" "success"}}

Alert Messages

Create important message callouts using Handlebars helpers:

{{alert "Use alerts to highlight important information!" "warning"}}

{{#alert type="info"}}
Advice: Don't overuse alerts!
{{/alert}}

Available Alert Types

• info - Blue, for general information
• success - Green, for positive messages
• warning - Orange/yellow, for important warnings
• error - Red, for critical alerts
• blank - Gray, for neutral information (default)

Available Badge Variants

• primary, secondary, accent - Brand colors
• info, success, warning, error - Status colors
• outline - Transparent with border

Benefits: Professional documentation with clean, consistent styling using Handlebars helpers for maximum flexibility.

4. 🌗 Auto Light/Dark Themes

Beautiful themes powered by Tailwind CSS and DaisyUI:

site:
  theme:
    light: "fantasy"    # Light themes: light, cupcake, bumblebee, emerald, corporate, garden, lofi, pastel, fantasy, wireframe, cmyk, autumn, business, acid, lemonade, winter
    dark: "forest"      # Dark themes: dark, synthwave, retro, cyberpunk, valentine, halloween, forest, aqua, luxury, dracula, black, night, coffee, dim, nord, sunset

Screenshot of the light theme and dark theme is shown below:

Benefits:

• Automatic OS theme detection
• Toggle between themes
• 32+ professional themes included
• Fully responsive design
• Based on DaisyUI themes

5. ⚡ Full-Text Search

Instant search across all documentation:

• Client-side: No server required
• Instant results: Search as you type
• Smart ranking: Most relevant results first
• Keyboard shortcuts: Quick navigation

search:
  enabled: true
  placeholder: "Search documentation..."

Benefits: Users find answers fast. Works offline and scales to thousands of pages.

6. 🔍 SEO Optimization

Built-in SEO features for better discoverability:

• Automatic sitemap.xml - Generated with every build for search engine indexing
• Meta descriptions - Configure in okidoki.yaml for better search results
• Semantic HTML - Clean, accessible markup for search engines
• Fast loading - Optimized performance improves search rankings
• Subdirectory support - Configure baseUrl for hosting under subdirectories (required for GitHub Pages)

site:
  title: "My Documentation"
  description: "Complete API documentation and guides"  # Used in meta tags
  baseUrl: "/my-repo/"  # Required for GitHub Pages: username.github.io/my-repo/

GitHub Pages Example: With baseUrl: "/my-repo/", your site works correctly at username.github.io/my-repo/.

Benefits: Better search engine visibility means more users find your documentation naturally.

7. 🌐 Host Anywhere

Deploy your documentation anywhere static files are supported - no server required:

• Pure static HTML - No runtime dependencies or server-side processing
• Powered by Tailwind CSS - Optimized, modern styling that loads instantly
• Zero dependencies - Everything needed is built into the generated files
• Lightning fast - Optimized assets and minimal payload for sub-second load times

# Deploy to any of these platforms:
- GitHub Pages
- Netlify  
- Vercel
- AWS S3
- Azure Static Web Apps
- Your own CDN/server

Benefits: Maximum flexibility and performance. Host on free platforms or enterprise infrastructure - your choice. No vendor lock-in for hosting either.

Why OkiDoki?

• Fast: Generate docs in under 1 second
• Small: ~50KB generated sites
• Simple: Two config files, standard markdown
• Powerful: Variables, themes, search, components
• SEO Ready: Automatic sitemaps and optimized markup
• Host Anywhere: Pure static HTML with zero dependencies
• Open Source: Community-driven, transparent, and free forever

🔓 Open Source Benefits

OkiDoki is 100% open source, which means:

• No vendor lock-in: Your content stays yours in standard markdown
• Community-driven: Features requested and built by real users
• Transparent: See exactly how your docs are generated
• Extensible: Contribute features, themes, and improvements
• Free forever: No licensing fees, usage limits, or hidden costs
• Trustworthy: Audit the code, report issues, fix bugs together

Get started in 30 seconds: npm install -g okidoki && okidoki init 🚀