Readme.md

Kirby Docs search workflow for Alfred 5

An ultra-fast Kirby Docs search workflow for Alfred 5

⚠️ You need to have PHP installed!

You need PHP 8+ to run this workflow. The absolutely easiest way is to download MAMP. The next easiest, and much better for your hard drive is to install PHP via Homebrew. Once you install the PHP, note down the path to its binaries, and install the workflow.

• Homebrew: /opt/homebrew/bin
• MAMP: /Applications/MAMP/bin/php/php8.0.8/bin

Installation

1. Download the latest version
2. Install the workflow by double-clicking the .alfredworkflow file
3. During the import, there are two configurable fields:
   • Shell command for PHP - Here's where you can add shell code to locate your PHP binary. e.g.: export PATH=/opt/homebrew/bin:$PATH
   • Use Adam's shortcuts - There's a number of pages that are missing from Kirby's Algolia Index
4. You can use the search now :)

Usage

• Open Alfred prompt
• kd <query> - Search the Kirby docs
• kd <A> <query> - if your query is preceded by a single letter - one of [cgkpr] - followed by a space, the query search will be limited to the area this letter refers to:
  • c - Cookbook
  • g - Guide
  • k - Kosmos
  • p - Plugins
  • r - Reference
• special shortcuts - There is a number of links missing from the index, but these specific were really missing for me, so if you check the "adam's shortcuts" checkbox, they'll be there for you:
  • kt - KirbyText: Reference index
  • help - Helpers
  • fmidx - Field methods index
  • icons - Icon index
  • allc - All classes
  • roots - System > Roots
  • validators - System > Validators
  • hooks - List of hooks
  • uilist - UI Kit Index
  • tools - Toolkit

Acknowledgments

• Matt Clinton and their Alfred Tailwind Docs search, which I used as a reference
• Bastian Allgeier for allowing me to piggyback on the Algolia search index already available on getkirby.com

Copyright / License

(c) 2021-2022 Adam Kiss, licensed under MIT License.