Extension Icon

BookStack

Seamlessly integrates Raycast with BookStack to search and manage your documentation directly from your macOS desktop.
Overview

BookStack Integration for Raycast

BookStack Integration for Raycast enables you to seamlessly search and manage your documentation directly from your macOS desktop using the powerful Raycast app.

Features

  • Search Documentation: Quickly find pages, chapters, or books in BookStack with ease.
  • View All Books: Easily list and access all your BookStack books directly from Raycast.
  • View All Shelves: Effortlessly browse through all your BookStack shelves and open them directly in your browser.

Usage

  • Use the Search documentation command to quickly search through your BookStack contents and open the results directly from Raycast.
  • Use the Show all books command to list all your BookStack books and access them with a single click.
  • Use the Show all shelves command to browse through all your BookStack shelves and open them directly in your browser.

Configuration

Before using the extension, make sure to set up your BookStack preferences in Raycast settings. You'll need to provide the base URL of your BookStack instance along with the API token ID and token secret.

Requirements

  • Raycast
  • BookStack instance with API access

Feedback

If you encounter any issues or have suggestions for improvement, feel free to open an issue on GitHub.

License

This project is licensed under the MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.