Plug docs fetch
This commit is contained in:
Zef Hemel
parent
bc5cdff323
commit
9a562dd0fb
1
.vscode/settings.json
vendored
1
.vscode/settings.json
vendored
@ -1,6 +1,5 @@
|
||||
{
|
||||
"editor.formatOnSave": true,
|
||||
"typescriptHero.imports.stringQuoteStyle": "\"",
|
||||
"deno.enable": true,
|
||||
"deno.importMap": "import_map.json",
|
||||
"deno.config": "deno.jsonc",
|
||||
|
||||
@ -12,10 +12,7 @@ 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
|
||||
|
||||
|
||||
@ -9,48 +9,59 @@ share-support: true
|
||||
<!-- #include [[https://raw.githubusercontent.com/silverbulletmd/silverbullet-ghost/main/README.md]] -->
|
||||
# Ghost plug for Silver Bullet
|
||||
|
||||
This allows you to publish your pages as [Ghost](https://ghost.org/) pages or posts. I use it to publish [Zef+](https://zef.plus).
|
||||
This allows you to publish your pages as [Ghost](https://ghost.org/) pages or
|
||||
posts. I use it to publish [Zef+](https://zef.plus).
|
||||
|
||||
## Configuration
|
||||
|
||||
In your `SETTINGS` specify the following settings:
|
||||
|
||||
```yaml
|
||||
ghost:
|
||||
myblog:
|
||||
url: https://your-ghost-blog.ghost.io
|
||||
```
|
||||
```yaml
|
||||
ghost:
|
||||
myblog:
|
||||
url: https://your-ghost-blog.ghost.io
|
||||
```
|
||||
|
||||
Then, create a Custom Integration (in your Ghost control panel under Settings > Advanced > Integrations > Add Custom Integration). Enter a name (whatever you want), then copy the full Admin API Key in your `SECRETS` file, mirroring the structure of SETTINGS:
|
||||
Then, create a Custom Integration (in your Ghost control panel under Settings >
|
||||
Advanced > Integrations > Add Custom Integration). Enter a name (whatever you
|
||||
want), then copy the full Admin API Key in your `SECRETS` file, mirroring the
|
||||
structure of SETTINGS:
|
||||
|
||||
```yaml
|
||||
ghost:
|
||||
myblog: your:adminkey
|
||||
```
|
||||
```yaml
|
||||
ghost:
|
||||
myblog: your:adminkey
|
||||
```
|
||||
|
||||
## Usage
|
||||
The plugin hooks into Silver Bullet's [Share infrastructure](https://silverbullet.md/%F0%9F%94%8C_Share). Therefore to share a page as either a Ghost page or post, add a `$share` front matter key. For posts, this should take the shape of:
|
||||
|
||||
---
|
||||
$share:
|
||||
- ghost:myblog:post:my-post-slug
|
||||
---
|
||||
The plugin hooks into Silver Bullet's
|
||||
[Share infrastructure](https://silverbullet.md/%F0%9F%94%8C_Share). Therefore to
|
||||
share a page as either a Ghost page or post, add a `$share` front matter key.
|
||||
For posts this should take the shape of:
|
||||
|
||||
---
|
||||
$share:
|
||||
- ghost:myblog:post:my-post-slug
|
||||
---
|
||||
|
||||
And for pages:
|
||||
|
||||
---
|
||||
$share:
|
||||
- ghost:myblog:page:my-page-slug
|
||||
---
|
||||
---
|
||||
$share:
|
||||
- ghost:myblog:page:my-page-slug
|
||||
---
|
||||
|
||||
Now, when you {[Share: Publish]} (Cmd-s/Ctrl-s) your post will automatically be created (as a draft) or updated if it already exists.
|
||||
Now, when you {[Share: Publish]} (Cmd-s/Ctrl-s) your post will automatically be
|
||||
created (as a draft) or updated if it already exists.
|
||||
|
||||
Enjoy!
|
||||
|
||||
## 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, or simply use the `Plugs: Add` command:
|
||||
|
||||
```
|
||||
- github:silverbulletmd/silverbullet-ghost/ghost.plug.json
|
||||
- github:silverbulletmd/silverbullet-ghost/ghost.plug.js
|
||||
```
|
||||
|
||||
Then run the `Plugs: Update` command and off you go!
|
||||
|
||||
@ -9,7 +9,7 @@ author: Zef Hemel
|
||||
# Silver Bullet KaTeX plug
|
||||
|
||||
## Installation
|
||||
Run the {[Plugs: Add]} command and paste in: `github:silverbulletmd/silverbullet-katex/katex.plug.json`
|
||||
Run the {[Plugs: Add]} command and paste in: `github:silverbulletmd/silverbullet-katex/katex.plug.js`
|
||||
|
||||
That's all!
|
||||
|
||||
@ -23,7 +23,7 @@ Put a latex block in your markdown:
|
||||
|
||||
And move your cursor outside of the block to live preview it!
|
||||
|
||||
**Note:** [KaTeX](https://katex.org) itself is not bundled with this plug; it pulls the JavaScript, CSS and fonts from the JSDelivr CDN. This means _this plug will not work without an Internet connection_. This limitation is because it is not yet possible to distribute font files via plugs, and KaTeX depends on specific web fonts.
|
||||
**Note:** [KaTeX](https://katex.org) itself is not bundled with this plug, it pulls the JavaScript, CSS and fonts from the JSDelivr CDN. This means _this plug will not work without an Internet connection_. The reason for this limitation is that it is not yet possible to distribute font files via plugs, and KaTeX depends on specific web fonts.
|
||||
|
||||
## Build
|
||||
Assuming you have Deno and Silver Bullet installed, simply build using:
|
||||
@ -38,7 +38,7 @@ Or to watch for changes and rebuild automatically
|
||||
deno task watch
|
||||
```
|
||||
|
||||
Then, load the locally built plug and add it to your `PLUGS` note with an absolute path, for instance:
|
||||
Then, load the locally built plug, add it to your `PLUGS` note with an absolute path, for instance:
|
||||
|
||||
```
|
||||
- file:/Users/you/path/to/katex.plug.json
|
||||
|
||||
@ -12,7 +12,7 @@ This plug adds basic [Mermaid](https://mermaid.js.org/) support to Silver Bullet
|
||||
**Note:** The Mermaid library itself is not bundled with this plug, it pulls the JavaScript from the JSDelivr CDN. This means _this plug will not work without an Internet connection_. The reason for this is primarily plug size (bundling the library would amount to 1.1MB). This way Mermaid is only loaded on pages with actual Mermaid diagrams rather than on every SB load.
|
||||
|
||||
## Installation
|
||||
Run the {[Plugs: Add]} command and paste in: `github:silverbulletmd/silverbullet-mermaid/mermaid.plug.json`
|
||||
Run the {[Plugs: Add]} command and paste in: `github:silverbulletmd/silverbullet-mermaid/mermaid.plug.js`
|
||||
|
||||
That's all!
|
||||
|
||||
@ -26,25 +26,4 @@ Put a mermaid block in your markdown:
|
||||
```
|
||||
|
||||
And move your cursor outside of the block to live preview it!
|
||||
|
||||
## Build
|
||||
Assuming you have Deno and Silver Bullet installed, simply build using:
|
||||
|
||||
```shell
|
||||
deno task build
|
||||
```
|
||||
|
||||
Or to watch for changes and rebuild automatically
|
||||
|
||||
```shell
|
||||
deno task watch
|
||||
```
|
||||
|
||||
Then, load the locally built plug and add it to your `PLUGS` note with an absolute path, for instance:
|
||||
|
||||
```
|
||||
- file:/Users/you/path/to/mermaid.plug.json
|
||||
```
|
||||
|
||||
And run the `Plugs: Update` command in SilverBullet.
|
||||
<!-- /include -->
|
||||
|
||||
@ -29,7 +29,7 @@ These plugs are distributed with SilverBullet and are automatically enabled:
|
||||
## Third-party plugs
|
||||
These plugs are written either by third parties or distributed separately from the main SB distribution:
|
||||
<!-- #query page where type = "plug" and uri != null order by name render [[template/plug]] -->
|
||||
* [[🔌 Backlinks]] by **Guillermo Vayá** ([repo](https://github.com/Willyfrog/silverbullet-backlinks))
|
||||
* [[🔌 Backlinks]] by **Guillermo Vayá** ([repo](https://github.com/silverbulletmd/silverbullet-backlinks))
|
||||
* [[🔌 Ghost]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-ghost))
|
||||
* [[🔌 Git]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-git))
|
||||
* [[🔌 Github]] by **Zef Hemel** ([repo](https://github.com/silverbulletmd/silverbullet-github))
|
||||
|
||||
@ -7,7 +7,7 @@ author: SilverBullet Authors
|
||||
|
||||
<!-- #include [[https://raw.githubusercontent.com/silverbulletmd/silverbullet-twitter/main/README.md]] -->
|
||||
# SilverBullet for Twitter
|
||||
Currently, the only thing this plug offers is unfurling links to tweets. To use, paste in a link to a Tweet like `https://twitter.com/zef/status/1547943418403295232`, then run the `Link: Unfurl` command and select `Tweet content` to "enrich" the tweet URL with the content of the linked tweet, e.g.
|
||||
Currently the only thing this plug offers is unfurling links to tweets. To use, paste in a link to a Tweet like `https://twitter.com/zef/status/1547943418403295232`, then run the `Link: Unfurl` command and select `Tweet content` to "enrich" the tweet URL with the content of the linked tweet, e.g.
|
||||
|
||||
https://twitter.com/zef/status/1547687321679511552
|
||||
|
||||
@ -21,8 +21,8 @@ Turns into:
|
||||
Open (`cmd+k`) your `PLUGS` note in SilverBullet and add this plug to the list:
|
||||
|
||||
```yaml
|
||||
- github:silverbulletmd/silverbullet-twitter/twitter.plug.json
|
||||
- github:silverbulletmd/silverbullet-twitter/twitter.plug.js
|
||||
```
|
||||
|
||||
Then run the `Plugs: Update` command, and off you go!
|
||||
Then run the `Plugs: Update` command and off you go!
|
||||
<!-- /include -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user