OkiDoki – convert Markdown to beautiful docs with Tailwind/DaisyUI. Docs: okidoki.dev
OkiDoki is a free, open-source static site generator specifically designed for creating professional API documentation websites and technical documentation sites. Automatically generate API docs from OpenAPI/Swagger specs or transform your Markdown files into beautiful, searchable documentation with zero configuration required. Perfect for developer teams, software projects, and API providers who need fast documentation builds (sub-second generation) and lightweight, responsive websites.
Create beautiful API documentation with minimal effort and zero maintenance.
Visit the full documentation at the OkiDoki website.
The default OkiDoki start page:
Example API documentation page:
Responsive design:
Install the OkiDoki documentation generator globally via npm from the official package:
npm install -g okidoki
Create a new documentation project directory:
mkdir mydocs && cd mydocs
Initialize your documentation site:
okidoki init
Automatically creates project structure with configuration files and sample content.
Build your static documentation site:
okidoki generate
Generates optimized HTML, CSS, and JavaScript files for deployment.
Tip: Use
okidoki openapi -i your-api-spec.yamlto automatically generate API documentation from OpenAPI/Swagger files.
Preview your documentation locally:
npx serve dist
Your documentation website will be available at http://localhost:3000
Alternative web servers: You can use any static file server - npx node-static dist, python -m http.server, or deploy to GitHub Pages, Netlify, Vercel, etc.
After running okidoki init, you'll have:
mydocs/
├── docs/
│ ├── index.md # Beautiful homepage
│ ├── start.md # This getting started guide
│ ├── help.md # Help and support page
│ └── test.md # Sample content page
├── okidoki.yaml # Main configuration
├── sidebars.yaml # Navigation structure
└── dist/ # Generated site (after build)
site:
title: "My Documentation"
description: "Documentation for my project"
menu:
- title: Getting Started
document: /start.md
- title: API Reference
document: /api.md
- title: Examples
document: /examples.md
Create a new markdown file start.md in the docs/ directory:
# My First Page
This is my first documentation page with **bold text** and `code`.
## My API Documentation
OkiDoki converts Markdown documents into beautiful documentation:
**example code:**
```http
GET /api/users
Content-Type: application/json
{
"users": [
{ "id": 1, "name": "John Doe" }
]
}
The run the okidoki generate command again and refresh your browser to see the updated documentation site.
OkiDoki is a community-driven open source project and we welcome contributions from developers worldwide. Join our growing community:
OkiDoki is released under the MIT License. You're free to use, modify, and distribute it for any purpose.
Compare OkiDoki with other popular API documentation tools and static site generators:
Detailed Comparison Guide: Read our in-depth documentation generator comparison and feature analysis to find the best tool for your API documentation and technical writing needs.
FAQs
OkiDoki – convert Markdown to beautiful docs with Tailwind/DaisyUI. Docs: okidoki.dev
We found that okidoki demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
A supply chain attack on Axios introduced a malicious dependency, plain-crypto-js@4.2.1, published minutes earlier and absent from the project’s GitHub releases.
Research
Malicious versions of the Telnyx Python SDK on PyPI delivered credential-stealing malware via a multi-stage supply chain attack.
Security News
TeamPCP is partnering with ransomware group Vect to turn open source supply chain attacks on tools like Trivy and LiteLLM into large-scale ransomware operations.