Quick Start Guide

Welcome to OkiDoki!

Create beautiful documentation sites in seconds with this modern, open source documentation generator.

Ready to get started? Let’s create your documentation site in under 30 seconds! 🚀

Installation

Install OkiDoki globally using npm:

npm install -g okidoki

Quick Setup

Create a new documentation project:
```
mkdir mydocs && cd mydocs
```
Initialize your project:
```
okidoki init
```
This creates the basic structure with configuration files.
Generate your documentation:
```
okidoki generate
```
Serve your docs locally:
```
npx serve dist
```
Your documentation will be available at http://localhost:3000

Project Structure

After running okidoki init, you’ll have:

mydocs/
├── okidoki.yaml      # Main configuration
├── sidebars.yaml     # Navigation structure
├── docs/             # Your markdown files
│   └── index.md      # Homepage content
└── dist/             # Generated site (includes sitemap.xml)

Basic Configuration

okidoki.yaml

site:
  title: "My Documentation"
  description: "Documentation for my project"

sidebars.yaml

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

Writing Your First Page

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`.

## Code Example

```javascript
function hello() {
  console.log("Hello, OkiDoki!");
}

The run the okidoki generate command again and refresh your browser to see the updated documentation site.

Next Steps

Check out the Documentation Reference for advanced features
Browse Examples for inspiration
Visit the Help section if you run into issues

Key Features

Markdown First: Write in standard markdown, no proprietary formats
Fast Search: Full-text search across all documentation
Clean Themes: Beautiful, responsive themes out of the box
Quick Build: Generate docs in under 1 second
Small Footprint: Generated sites are ~50KB