Website updates

pull/109/head
Zef Hemel 2022-10-29 09:48:10 +02:00
parent a11f0f5b31
commit c54e93a2b9
8 changed files with 105 additions and 123 deletions

View File

@ -25,7 +25,7 @@ Heres a list of (non-built-in) plugs documented in this space (note the
* [[🔌 Git]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-github)) * [[🔌 Git]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-github))
* [[🔌 Github]] 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)) * [[🔌 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))
<!-- /query --> <!-- /query -->
In a regular SB installation, the body of this query 👆 (in between the In a regular SB installation, the body of this query 👆 (in between the

View File

@ -1,22 +1,20 @@
```meta ---
type: plug type: plug
uri: ghr:Willyfrog/silverbullet-backlinks uri: ghr:Willyfrog/silverbullet-backlinks
repo: https://github.com/Willyfrog/silverbullet-backlinks repo: https://github.com/Willyfrog/silverbullet-backlinks
author: Guillermo Vayá author: Guillermo Vayá
``` ---
<!-- #include "https://raw.githubusercontent.com/Willyfrog/silverbullet-backlinks/main/README.md" -->
<!-- #include [[https://raw.githubusercontent.com/Willyfrog/silverbullet-backlinks/main/README.md]] -->
# SilverBullet plug for Backlinks # SilverBullet plug for Backlinks
Provides access to pages that link to the one currently being edited. Provides access to pages that link to the one currently being edited.
## Wait, SilverBullet? ## Wait, SilverBullet?
If you don't know what it is, check its [webpage](https://silverbullet.md), but If you don't know what it is, check its [webpage](https://silverbullet.md), but if
if you want me to spoil the fun: it is an extensible note taking app with you want me to spoil the fun: it is an extensible note taking app with markdown and plain files at its core
markdown and plain files at its core (well... there is a bit of magic in there (well... there is a bit of magic in there too, but what good it would be without a little magic?)
too, but what good it would be without a little magic?)
## Installation ## 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! Then run the `Plugs: Update` command and off you go!
<!-- /include --> <!-- /include -->

View File

@ -1,15 +1,16 @@
```meta ---
type: plug type: plug
uri: github:silverbulletmd/silverbullet-ghost/ghost.plug.json uri: github:silverbulletmd/silverbullet-ghost/ghost.plug.json
repo: https://github.com/silverbulletmd/silverbullet-ghost repo: https://github.com/silverbulletmd/silverbullet-ghost
author: Zef Hemel author: Zef Hemel
``` ---
<!-- #include "https://raw.githubusercontent.com/silverbulletmd/silverbullet-ghost/main/README.md" --> **Note:** Currently in broken state, needs updating.
<!-- #include [[https://raw.githubusercontent.com/silverbulletmd/silverbullet-ghost/main/README.md]] -->
# Ghost plug for Silver Bullet # Ghost plug for Silver Bullet
Note: Still very basic. To use: Note: Still very basic, to use:
In your `SETTINGS` specify the following settings: In your `SETTINGS` specify the following settings:
@ -25,13 +26,11 @@ And in your `SECRETS` file:
ghostAdminKey: your:adminkey ghostAdminKey: your:adminkey
``` ```
This will assume the naming pattern of `posts/my-post-slug` where the first 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.
top-level heading (`# Hello`) will be used as the post title.
Commands to use `Ghost: Publish` Commands to use `Ghost: Publish`
## Installation ## Installation
Open your `PLUGS` note in SilverBullet and add this plug to the list: 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! Then run the `Plugs: Update` command and off you go!
<!-- /include --> <!-- /include -->

View File

@ -1,31 +1,25 @@
```meta ---
type: plug type: plug
uri: github:silverbulletmd/silverbullet-github/github.plug.json uri: github:silverbulletmd/silverbullet-github/github.plug.json
repo: https://github.com/silverbulletmd/silverbullet-github repo: https://github.com/silverbulletmd/silverbullet-github
author: Zef Hemel author: Zef Hemel
``` ---
<!-- #include "https://raw.githubusercontent.com/silverbulletmd/silverbullet-git/main/README.md" -->
<!-- #include [[https://raw.githubusercontent.com/silverbulletmd/silverbullet-git/main/README.md]] -->
# SilverBullet plug for Git # 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`: `Git : Sync`:
* Adds all *.md files in your folder to git
- Adds all *.md files in your folder to git * It commits them with a "Snapshot" commit message
- It commits them with a "Snapshot" commit message * It `git pull`s changes from the remote server
- It `git pull`s changes from the remote server * It `git push`es changes to the remote server
- It `git push`es changes to the remote server
`Git: Snapshot`: `Git: Snapshot`:
* Asks you for a commit message
- Asks you for a commit message * Commits
- Commits
## Installation ## Installation
Open your `PLUGS` note in SilverBullet and add this plug to the list: 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! Then run the `Plugs: Update` command and off you go!
## To Build
```shell
deno task build
```
<!-- /include --> <!-- /include -->

View File

@ -1,19 +1,15 @@
```meta ---
type: plug type: plug
uri: github:silverbulletmd/silverbullet-github/github.plug.json uri: github:silverbulletmd/silverbullet-github/github.plug.json
repo: https://github.com/silverbulletmd/silverbullet-github repo: https://github.com/silverbulletmd/silverbullet-github
author: Zef Hemel author: Zef Hemel
``` ---
<!-- #include [[https://raw.githubusercontent.com/silverbulletmd/silverbullet-github/main/README.md]] --> <!-- #include [[https://raw.githubusercontent.com/silverbulletmd/silverbullet-github/main/README.md]] -->
# SilverBullet plug for Github # 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 ## Installation
Open your `PLUGS` note in SilverBullet and add this plug to the list: Open your `PLUGS` note in SilverBullet and add this plug to the list:
``` ```
@ -23,12 +19,9 @@ Open your `PLUGS` note in SilverBullet and add this plug to the list:
Then run the `Plugs: Update` command and off you go! Then run the `Plugs: Update` command and off you go!
## Configuration ## 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 To configure, add a `githubToken` key to your `SECRETS` page, this should be a [personal access token](https://github.com/settings/tokens):
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):
```yaml ```yaml
githubToken: your-github-token githubToken: your-github-token
@ -36,11 +29,13 @@ To configure, add a `githubToken` key to your `SECRETS` page, this should be a
## Query sources ## Query sources
- `gh-event` required filters in the `where` clause: * `gh-event` List events of a user
- `username`: the user whose events to query * `username`: the user whose events to query
- `gh-pull` * `gh-pull`: List pull requests in a repository
- `repo`: the repo to query PRs for * `repo`: the repo to query PRs for
- `gh-notification` requires a `githubToken` to be configured in `SECRETS`. * `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 ## Example
@ -52,12 +47,11 @@ Example uses:
<!-- /query --> <!-- /query -->
## Recent PRs ## Recent PRs
<!-- #query gh-pull where repo = "silverbulletmd/silverbullet" and user_login = "zefhemel" limit 3 render [[template/gh-pull]] --> <!-- #query gh-pull where repo = "silverbulletmd/silverbullet" and user_login = "zefhemel" limit 3 render "template/gh-pull" -->
<!-- /query --> <!-- /query -->
Where the `template/gh-pull` looks as follows: Where the `template/gh-pull` looks as follows:
* ({{state}}) [{{title}}]({{html_url}}) * ({{state}}) [{{title}}]({{html_url}})
<!-- /include --> <!-- /include -->

View File

@ -1,19 +1,15 @@
```meta ---
type: plug type: plug
uri: github:silverbulletmd/silverbullet-mattermost/mattermost.plug.json uri: github:silverbulletmd/silverbullet-mattermost/mattermost.plug.json
repo: https://github.com/silverbulletmd/silverbullet-mattermost repo: https://github.com/silverbulletmd/silverbullet-mattermost
author: Zef Hemel author: Zef Hemel
``` ---
<!-- #include "https://raw.githubusercontent.com/silverbulletmd/silverbullet-mattermost/main/README.md" -->
<!-- #include [[https://raw.githubusercontent.com/silverbulletmd/silverbullet-mattermost/main/README.md]] -->
# Mattermost plug for Silver Bullet # Mattermost plug for Silver Bullet
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.
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.
## Installation ## Installation
Open your `PLUGS` note in SilverBullet and add this plug to the list: 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! Then run the `Plugs: Update` command and off you go!
## Configuration ## Configuration
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:
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 ```yaml
mattermostUrl: https://community.mattermost.com mattermostUrl: https://community.mattermost.com
mattermostDefaultTeam: core mattermostDefaultTeam: core
``` ```
In `SECRETS` provide a Mattermost personal access token (or hijack one from your In `SECRETS` provide a Mattermost personal access token (or hijack one from your current session):
current session):
```yaml ```yaml
mattermostToken: your-token mattermostToken: your-token
``` ```
To make this look good, it's recommended you render your query results a 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`:
template. Here is one to start with, you can keep it in e.g.
`templates/mm-saved`:
[{{username}}]({{desktopUrl}}) in **{{channelName}}** at {{updatedAt}} {[Unsave]}: [{{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 Note that the `{[Unsaved]}` "button" when clicked, will unsave the post automatically 😎
automatically 😎
If you use the `mm-boards` query provider, you do not need any configuration of secrets.
## Query sources ## 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
Example uses (using the `template/mm-saved` template above): Example use of `mm-saved` (using the `template/mm-saved` template above):
<!-- #query mm-saved order by updatedAt desc limit 5 render "template/mm-saved" --> <!-- #query mm-saved order by updatedAt desc limit 5 render "template/mm-saved" -->
<!-- /query --> <!-- /query -->
Example use of `mm-board`:
<!-- #query mm-board where url = "https://community.mattermost.com/plugins/focalboard/workspace/p33mj7xh4frntrtbxbp5xp1joy/shared/bbam1crdg6jn93qhcgiq8xbpk8a/vqnxrjaewnibrtnp8m38fswt63e?r=keadbck8m8oc84ng6ozhcqqcgpc" and team = "Server Platform" and quarter = "2022 Q3" select objective, title, status -->
<!-- /query -->
<!-- /include --> <!-- /include -->

View File

@ -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
```
<!-- #include "https://raw.githubusercontent.com/silverbulletmd/silverbullet-mount/main/README.md" -->
# 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
```
<!-- /include -->

View File

@ -0,0 +1,31 @@
---
type: plug
uri: github:m1lt0n/silverbullet-serendipity/serendipity.plug.json
repo: https://github.com/m1lt0n/silverbullet-serendipity
author: Pantelis Vratsalis
---
<!-- #include [[https://raw.githubusercontent.com/m1lt0n/silverbullet-serendipity/main/README.md]] -->
# 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!
<!-- /include -->