Thanks to visit codestin.com
Credit goes to okidoki.dev

OkiDoki

Open source, simple, fast documentation generator that turns your markdown files into beautiful docs

Quick Start Documentation

Get running in 30 seconds

npm install -g okidoki

mkdir mydocs && cd mydocs

okidoki init

okidoki generate

npx serve dist

Server running at http://localhost:3000

Markdown First

Write in standard markdown. No proprietary formats.

Fast Search

Full-text search across all your documentation.

Clean Themes

Beautiful, responsive themes out of the box.

Simple Configuration

okidoki.yaml

site:
    title: "My API Docs"
    description: "Documentation for my API"
    theme:
        light: "fantasy"
        dark: "aqua"

    globals:
        version: "1.0.0"
        api_url: "https://api.example.com"

sidebars.yaml

menu:
    - title: "Getting Started"
        document: /start.md
    - title: "API Reference"
        document: /api.md
    - title: "Examples"
        document: /examples.md

Documentation

Documentation samples

Help

Troubleshooting

Version

1.1.35

Build Time

< 1s

File Size

~50KB