diff --git a/website/Silver Bullet.md b/website/Silver Bullet.md index 68f759f0..e91096c6 100644 --- a/website/Silver Bullet.md +++ b/website/Silver Bullet.md @@ -25,7 +25,7 @@ Here’s a list of (non-built-in) plugs documented in this space (note the * [[πŸ”Œ Git]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-github)) * [[πŸ”Œ Github]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-github)) * [[πŸ”Œ Mattermost]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-mattermost)) -* [[πŸ”Œ Mount]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-mount)) +* [[πŸ”Œ Serendipity]] by **Pantelis Vratsalis** ([repo](https://github.com/m1lt0n/silverbullet-serendipity)) In a regular SB installation, the body of this query πŸ‘† (in between the diff --git a/website/πŸ”Œ Backlinks.md b/website/πŸ”Œ Backlinks.md index 202e750d..ebd7b6b9 100644 --- a/website/πŸ”Œ Backlinks.md +++ b/website/πŸ”Œ Backlinks.md @@ -1,22 +1,20 @@ -```meta +--- type: plug uri: ghr:Willyfrog/silverbullet-backlinks repo: https://github.com/Willyfrog/silverbullet-backlinks author: Guillermo VayΓ‘ -``` - - +--- + # SilverBullet plug for Backlinks Provides access to pages that link to the one currently being edited. ## Wait, SilverBullet? -If you don't know what it is, check its [webpage](https://silverbullet.md), but -if you want me to spoil the fun: it is an extensible note taking app with -markdown and plain files at its core (well... there is a bit of magic in there -too, but what good it would be without a little magic?) +If you don't know what it is, check its [webpage](https://silverbullet.md), but if +you want me to spoil the fun: it is an extensible note taking app with markdown and plain files at its core +(well... there is a bit of magic in there too, but what good it would be without a little magic?) ## Installation @@ -27,5 +25,4 @@ Open (`cmd+k`) your `PLUGS` note in SilverBullet and add this plug to the list: ``` Then run the `Plugs: Update` command and off you go! - diff --git a/website/πŸ”Œ Ghost.md b/website/πŸ”Œ Ghost.md index 1b823913..a83cd144 100644 --- a/website/πŸ”Œ Ghost.md +++ b/website/πŸ”Œ Ghost.md @@ -1,37 +1,36 @@ -```meta +--- type: plug uri: github:silverbulletmd/silverbullet-ghost/ghost.plug.json repo: https://github.com/silverbulletmd/silverbullet-ghost author: Zef Hemel -``` +--- - +**Note:** Currently in broken state, needs updating. + # Ghost plug for Silver Bullet -Note: Still very basic. To use: +Note: Still very basic, to use: In your `SETTINGS` specify the following settings: - ```yaml - ghostUrl: https://your-ghost-blog.ghost.io - ghostPostPrefix: posts - ghostPagePrefix: pages - ``` + ```yaml + ghostUrl: https://your-ghost-blog.ghost.io + ghostPostPrefix: posts + ghostPagePrefix: pages + ``` And in your `SECRETS` file: - ```yaml - ghostAdminKey: your:adminkey - ``` + ```yaml + ghostAdminKey: your:adminkey + ``` -This will assume the naming pattern of `posts/my-post-slug` where the first -top-level heading (`# Hello`) will be used as the post title. +This will assume the naming pattern of `posts/my-post-slug` where the first top-level heading (`# Hello`) will be used as the post title. Commands to use `Ghost: Publish` ## Installation - Open your `PLUGS` note in SilverBullet and add this plug to the list: ``` @@ -39,5 +38,4 @@ Open your `PLUGS` note in SilverBullet and add this plug to the list: ``` Then run the `Plugs: Update` command and off you go! - diff --git a/website/πŸ”Œ Git.md b/website/πŸ”Œ Git.md index faa21b42..de0cfb58 100644 --- a/website/πŸ”Œ Git.md +++ b/website/πŸ”Œ Git.md @@ -1,31 +1,25 @@ -```meta +--- type: plug uri: github:silverbulletmd/silverbullet-github/github.plug.json repo: https://github.com/silverbulletmd/silverbullet-github author: Zef Hemel -``` - - +--- + # SilverBullet plug for Git - -Very basic in functionality, it assumes you have git configured for push and -pull in your space. What it does, roughly speaking: +Very basic in functionality, it assumes you have git configured for push and pull in your space. What it does, roughly speaking: `Git : Sync`: - -- Adds all *.md files in your folder to git -- It commits them with a "Snapshot" commit message -- It `git pull`s changes from the remote server -- It `git push`es changes to the remote server +* Adds all *.md files in your folder to git +* It commits them with a "Snapshot" commit message +* It `git pull`s changes from the remote server +* It `git push`es changes to the remote server `Git: Snapshot`: - -- Asks you for a commit message -- Commits +* Asks you for a commit message +* Commits ## Installation - Open your `PLUGS` note in SilverBullet and add this plug to the list: ``` @@ -34,4 +28,8 @@ Open your `PLUGS` note in SilverBullet and add this plug to the list: Then run the `Plugs: Update` command and off you go! +## To Build +```shell +deno task build +``` diff --git a/website/πŸ”Œ Github.md b/website/πŸ”Œ Github.md index 0539784a..571c57e6 100644 --- a/website/πŸ”Œ Github.md +++ b/website/πŸ”Œ Github.md @@ -1,19 +1,15 @@ -```meta +--- type: plug uri: github:silverbulletmd/silverbullet-github/github.plug.json repo: https://github.com/silverbulletmd/silverbullet-github author: Zef Hemel -``` +--- - # SilverBullet plug for Github - -Provides Github events, notifications and pull requests as query sources using -SB's query mechanism +Provides Github events, notifications and pull requests as query sources using SB's query mechanism ## Installation - Open your `PLUGS` note in SilverBullet and add this plug to the list: ``` @@ -23,24 +19,23 @@ Open your `PLUGS` note in SilverBullet and add this plug to the list: Then run the `Plugs: Update` command and off you go! ## Configuration +This step is optional for anything but the `gh-notification` source, but without it you may be rate limited by the Github API, -This step is optional for anything but the `gh-notification` source, but without -it you may be rate limited by the Github API, +To configure, add a `githubToken` key to your `SECRETS` page, this should be a [personal access token](https://github.com/settings/tokens): -To configure, add a `githubToken` key to your `SECRETS` page, this should be a -[personal access token](https://github.com/settings/tokens): - - ```yaml - githubToken: your-github-token - ``` + ```yaml + githubToken: your-github-token + ``` ## Query sources -- `gh-event` required filters in the `where` clause: - - `username`: the user whose events to query -- `gh-pull` - - `repo`: the repo to query PRs for -- `gh-notification` requires a `githubToken` to be configured in `SECRETS`. +* `gh-event` List events of a user + * `username`: the user whose events to query +* `gh-pull`: List pull requests in a repository + * `repo`: the repo to query PRs for +* `gh-search-issue`: Search for issues and pull requests + * `query`: [the search query](https://docs.github.com/en/rest/search#search-issues-and-pull-requests) +* `gh-notification` requires a `githubToken` to be configured in `SECRETS`. ## Example @@ -52,12 +47,11 @@ Example uses: ## Recent PRs - + Where the `template/gh-pull` looks as follows: * ({{state}}) [{{title}}]({{html_url}}) - diff --git a/website/πŸ”Œ Mattermost.md b/website/πŸ”Œ Mattermost.md index 133ff207..68a6fbbd 100644 --- a/website/πŸ”Œ Mattermost.md +++ b/website/πŸ”Œ Mattermost.md @@ -1,19 +1,15 @@ -```meta +--- type: plug uri: github:silverbulletmd/silverbullet-mattermost/mattermost.plug.json repo: https://github.com/silverbulletmd/silverbullet-mattermost author: Zef Hemel -``` - - +--- + # Mattermost plug for Silver Bullet - -Provides an `mm-saved` query provider (and maybe more in the future). Please -follow the installation, configuration sections, and have a look at the example. +This plug provides a few query providers to query data from some of the [Mattermost suite](https://www.mattermost.com) of products. Please follow the installation, configuration sections, and have a look at the example. ## Installation - Open your `PLUGS` note in SilverBullet and add this plug to the list: ``` @@ -23,26 +19,20 @@ Open your `PLUGS` note in SilverBullet and add this plug to the list: Then run the `Plugs: Update` command and off you go! ## Configuration - -You need two bits of configuration to make this plug work. In `SETTINGS` provide -the `mattermostUrl` and `mattermostDefaultTeam` settings, they default to the -following: +When using the `mm-saved` query provide, you need two bits of configuration to make this plug work. In `SETTINGS` provide the `mattermostUrl` and `mattermostDefaultTeam` settings, they default to the following: ```yaml mattermostUrl: https://community.mattermost.com mattermostDefaultTeam: core ``` -In `SECRETS` provide a Mattermost personal access token (or hijack one from your -current session): +In `SECRETS` provide a Mattermost personal access token (or hijack one from your current session): ```yaml mattermostToken: your-token ``` -To make this look good, it's recommended you render your query results a -template. Here is one to start with, you can keep it in e.g. -`templates/mm-saved`: +To make this look good, it's recommended you render your query results a template. Here is one to start with, you can keep it in e.g. `templates/mm-saved`: [{{username}}]({{desktopUrl}}) in **{{channelName}}** at {{updatedAt}} {[Unsave]}: @@ -50,19 +40,31 @@ template. Here is one to start with, you can keep it in e.g. --- -Note that the `{[Unsaved]}` "button" when clicked, will unsave the post -automatically 😎 +Note that the `{[Unsaved]}` "button" when clicked, will unsave the post automatically 😎 + +If you use the `mm-boards` query provider, you do not need any configuration of secrets. ## Query sources -- `mm-saved` fetches (by default 15) saved posts in Mattermost +* `mm-saved` fetches (by default 15) saved posts in Mattermost +* `mm-board` fetches all cards from a Mattermost board exposed via a public share URL (obtained via Share > Publish > Publish to Web > Copy Link) via an `url =` filter (see example below) + +## Commands + +* `Convert post to note` fetches a post by passing its permalink and adds it to a note. If the note doesn't exist, it creates a new one. +* `Unfurl: permalink` available while positioning the caret on top of a mattermost permalink related to the configured url, will fetch the post contents. ## Example -Example uses (using the `template/mm-saved` template above): +Example use of `mm-saved` (using the `template/mm-saved` template above): +Example use of `mm-board`: + + + + diff --git a/website/πŸ”Œ Mount.md b/website/πŸ”Œ Mount.md deleted file mode 100644 index 26acb461..00000000 --- a/website/πŸ”Œ Mount.md +++ /dev/null @@ -1,38 +0,0 @@ -```meta -type: plug -uri: github:silverbulletmd/silverbullet-mount/mount.plug.json -repo: https://github.com/silverbulletmd/silverbullet-mount -author: Zef Hemel -``` - - - -# Mounting of external systems into SB - -Enables mounting of external folders or SB instances into your space. - -## Installation - -Open your `PLUGS` note in SilverBullet and add this plug to the list: - -``` -- github:silverbulletmd/silverbullet-mount/mount.plug.json -``` - -Then run the `Plugs: Update` command and off you go! - -## Configuration - -Create a `MOUNTS` page: - - ```yaml - # Mounting another local folder with a docs/ prefix - - prefix: docs/ - path: file:/Users/me/docs - # Mounting an external SB instance to remote/ - - prefix: remote/ - path: http://some-ip:3000 - password: mypassword - ``` - - diff --git a/website/πŸ”Œ Serendipity.md b/website/πŸ”Œ Serendipity.md new file mode 100644 index 00000000..41575728 --- /dev/null +++ b/website/πŸ”Œ Serendipity.md @@ -0,0 +1,31 @@ +--- +type: plug +uri: github:m1lt0n/silverbullet-serendipity/serendipity.plug.json +repo: https://github.com/m1lt0n/silverbullet-serendipity +author: Pantelis Vratsalis +--- + + +# Serendipity plug for SilverBullet + +Serendipity introduces randomness in your navigation to your pages and notes in [silverbullet](https://silverbullet.md/). + +The plug includes 3 commands: + +* Open a random page: navigates to a totally random page +* Open a random page that contains a tag (e.g. `#hobbies`): narrows down the random pages to only those that have a specific tag +* Open a random page based on a search term (e.g. `performance management`): narrows down the random pages to only those that match the search term. + +In order to easily access the commands, all of their names are prefixed with `Serendipity:`. + + +## Installation + +Open (`cmd+k` in Mac and `ctrl+k` in other systems) your `PLUGS` note in SilverBullet and add this plug to the list: + +```yaml +- github:m1lt0n/silverbullet-serendipity/serendipity.plug.json +``` + +Then run the `Plugs: Update` command and you're ready! +