Skip to content

Commit

Permalink
Add bookstack extension (#12036)
Browse files Browse the repository at this point in the history
* Add bookstack extension

- FEATURE: Adding Metadata images
- Removing unused image
- Updating readme
- Adding Show all books and show all shelves function
- First Dev push

* Update bookstack extension

- Removing zip
- Fixing build issues

* Format code with Prettier

* FIX: Command\'s title has to be Title Cased.

* FEATURE: Adding correct MIT Licence to readme

* Discard changes to extensions/bookstack/package.json

* sorry

* Update package.json

* Update CHANGELOG.md and optimise images

---------

Co-authored-by: Per Nielsen Tikær <per@raycast.com>
Co-authored-by: raycastbot <bot@raycast.com>
  • Loading branch information
3 people authored May 3, 2024
1 parent c68a8f4 commit e77a7f9
Show file tree
Hide file tree
Showing 18 changed files with 2,554 additions and 0 deletions.
4 changes: 4 additions & 0 deletions extensions/bookstack/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"root": true,
"extends": ["@raycast"]
}
14 changes: 14 additions & 0 deletions extensions/bookstack/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules

# Raycast specific files
raycast-env.d.ts
.raycast-swift-build
.swiftpm
compiled_raycast_swift

# misc
.DS_Store
/assets/sources
4 changes: 4 additions & 0 deletions extensions/bookstack/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"printWidth": 120,
"singleQuote": false
}
3 changes: 3 additions & 0 deletions extensions/bookstack/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# BookStack Changelog

## [Initial Version] - 2024-04-26
50 changes: 50 additions & 0 deletions extensions/bookstack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# 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](https://raycast.com/)
- BookStack instance with API access

## Feedback

If you encounter any issues or have suggestions for improvement, feel free to [open an issue](https://github.com/HuskiiBE/BookStack-RayCast/issues) 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.
Binary file added extensions/bookstack/assets/bookstack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions extensions/bookstack/assets/logo-bookstack.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added extensions/bookstack/metadata/bookstack-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added extensions/bookstack/metadata/bookstack-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added extensions/bookstack/metadata/bookstack-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e77a7f9

Please sign in to comment.