Skip to content

ichoosetoaccept/raycast-docset

Repository files navigation

Raycast Docset Generator

Generate a Dash docset for Raycast developer documentation.

Features

  • Scrapes all documentation from developers.raycast.com
  • Creates a properly indexed Dash docset with semantic search
  • Indexes API references, utilities, hooks, guides, and examples
  • Supports offline documentation browsing

Requirements

  • Python 3.14+
  • uv (recommended) or pip

Installation

# Clone the repository
git clone https://github.com/ichoosetoaccept/raycast-docset.git
cd raycast-docset

# Install dependencies with uv
uv sync

Usage

Scrape and build docset

# Scrape docs from developers.raycast.com and build docset
uv run python main.py --scrape

# Or specify a custom output directory
uv run python main.py --scrape --output ./my-output

Build from existing scraped docs

# If you've already scraped the docs
uv run python main.py --source .cache/raycast-docs

Using poe tasks

poe scrape   # Scrape docs from developers.raycast.com
poe build    # Build docset from scraped docs
poe verify   # Validate the docset
poe clean    # Remove output directory
poe all      # Scrape, build, and verify

Output

The generated docset will be at output/Raycast.docset.

To install in Dash:

  1. Open Dash
  2. Go to Preferences > Docsets
  3. Click + and select the .docset file

Or simply double-click the .docset file.

Project Structure

raycast-docset/
├── main.py                 # CLI entry point
├── raycast_docset/
│   ├── __init__.py
│   ├── scraper.py          # Web scraper for docs
│   ├── builder.py          # Docset builder
│   └── parsers.py          # Index entry parsers
├── pyproject.toml
└── README.md

License

MIT

About

Dash docset generator for Raycast API documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages