Skip to content
This repository has been archived by the owner on Feb 4, 2024. It is now read-only.

Search the CakePHP documentation using Alfred and Algolia

License

Notifications You must be signed in to change notification settings

techouse/alfred-cakephp-docs

Repository files navigation

CakePHP Docs Workflow for Alfred

GitHub release GitHub All Releases GitHub

Search the CakePHP documentation using Alfred.

demo

Installation

  1. Download the latest version
  2. Install the workflow by double-clicking the .alfredworkflow file
  3. You can add the workflow to a category, then click "Import" to finish importing. You'll now see the workflow listed in the left sidebar of your Workflows preferences pane.

Usage

Just type cake followed by your search query.

cake inflector

Either press ⌘Y to Quick Look the result, or press <enter> to open it in your web browser.

Changing Branches

The workflow supports searching the documentation of all the currently officially supported branches 4.x 3.x, and 2.x. By default it searches the 4.x branch. To search branch 3.x or 2.x simply type v3 or v2 anywhere in your query, like so:

cake v2 inflector

Note

The lightning fast search is powered by Algolia which was generous enough to hand me a big enough plan for all these Alfred Workflows. A big thank you to @redox from @algolia 😇 🍻 ❤️

The index for Algolia was compiled from the CakePHP Sphinx Egnlish HTML documentation using a simple Python script I wrote.