Welcome to Your Docs

getting-startedintroduction

Welcome to Your Docs

This is an example article to help you get started with semantic-docs.

Features

This theme includes:

  • 🔍 Semantic Search - Find content by meaning, not just keywords
  • 📱 Responsive Design - Works on all devices
  • 🎨 Dark Mode - Easy on the eyes
  • 📑 Auto TOC - Table of contents generated automatically

Reference Implementation

This is the HonoX port of semantic-docs, optimized for Cloudflare Workers:

This implementation showcases all features with HonoX, React islands, and edge deployment on Cloudflare Workers.

Getting Started

  1. Add your markdown files to the content/ directory
  2. Run pnpm index to index your content
  3. Start the dev server with pnpm dev

Try the search bar in the header! It uses vector embeddings to understand what you're looking for.

Customization

Check out the README for customization options:

  • Change colors
  • Update site title
  • Configure embedding providers
  • And more!

Ready to get started? Replace this file with your own content and run pnpm index!