Slight tweaks
This commit is contained in:
Zef Hemel
parent
0382ed4f0d
commit
8d326a668b
@ -167,7 +167,6 @@ functions:
|
||||
path: "./mentions_ps.ts:updateMentions"
|
||||
env: client
|
||||
events:
|
||||
- plug:load
|
||||
- editor:pageLoaded
|
||||
navigateToMention:
|
||||
path: "./mentions_ps.ts:navigate"
|
||||
@ -186,7 +185,6 @@ functions:
|
||||
path: toc_preface.ts:renderTOC
|
||||
env: client
|
||||
events:
|
||||
- plug:load
|
||||
- editor:pageLoaded
|
||||
|
||||
lintYAML:
|
||||
|
||||
@ -191,6 +191,17 @@ export class Client {
|
||||
console.warn("Not authenticated, redirecting to auth page");
|
||||
return;
|
||||
}
|
||||
if (e.message.includes("Offline") && !this.syncMode) {
|
||||
// Offline and not in sync mode, this is not going to fly.
|
||||
this.flashNotification(
|
||||
"Could not reach remote server, going to reload in a few seconds",
|
||||
"error",
|
||||
);
|
||||
setTimeout(() => {
|
||||
location.reload();
|
||||
}, 5000);
|
||||
throw e;
|
||||
}
|
||||
console.warn(
|
||||
"Could not reach remote server, we're offline or the server is down",
|
||||
e,
|
||||
@ -433,7 +444,7 @@ export class Client {
|
||||
|
||||
try {
|
||||
settingsText = (await this.space.readPage("SETTINGS")).text;
|
||||
} catch (e) {
|
||||
} catch (e: any) {
|
||||
console.info("No SETTINGS page, falling back to default", e);
|
||||
settingsText = '```yaml\nindexPage: "[[index]]"\n```\n';
|
||||
}
|
||||
|
||||
@ -11,6 +11,7 @@ release.
|
||||
* [[Live Queries]]: will highlight non-existing query sources and non-existing template references in `render` clauses
|
||||
* Basic [[Table of Contents]] support: any page _with 3 headers or more_, now has a “Table of Contents” widget appear (see this very page). You can toggle this feature using the {[Table of Contents: Toggle]} command.
|
||||
* Tapping/clicking the top bar (outside of the page name and action buttons) now scrolls your page to the very top.
|
||||
* Slightly more gracious error reporting on load, when using the Online [[Client Modes]] and the server is offline.
|
||||
|
||||
---
|
||||
## 0.5.6
|
||||
|
||||
@ -1,56 +0,0 @@
|
||||
What does SilverBullet look like? Well, have a look around. **You’re looking at it at this very moment!** 🤯
|
||||
|
||||
Note that what you’re looking at is not a fully functional version because the _back-end is read-only_. That said, it should give you some feel for what it’s like to use SB before making the commitment of running a single `deno` command (see here: [[SilverBullet]]) to download and run it locally in its fully functioning mode.
|
||||
|
||||
## Start playing
|
||||
So, feel free to make some edits in this space. Don’t worry, you won’t break anything, nothing is saved (just reload the page to see).
|
||||
|
||||
Here are some things to try:
|
||||
|
||||
* Click on the page picker (folder tree) icon at the top right, or hit `Cmd-k` (Mac) or `Ctrl-k` (Linux and Windows) to open the **page switcher**. Type the name of a nonexistent page to create it (although it won’t save in this environment).
|
||||
* Click on the run button (top right) or hit `Cmd-/` (Mac) or `Ctrl-/` (Linux and Windows) to open the **command palette** (note not all commands will work in this quasi read-only mode).
|
||||
* Select some text and hit `Alt-m` to ==highlight== it, or `Cmd-b` (Mac) or `Ctrl-b` to make it **bold**.
|
||||
* Click a link somewhere in this page to navigate there.
|
||||
* Start typing `[[` somewhere to insert a page link (with completion).
|
||||
* [ ] Tap this box 👈 to mark this task as done.
|
||||
* Start typing `:party` to trigger the emoji picker 🎉
|
||||
* Type `/` somewhere in the text to invoke a **slash command**.
|
||||
* Hit `Cmd-p` (Mac) or `Ctrl-p` (Windows, Linux) to show a live preview for the current page on the side, if your brain doesn’t speak native Markdown yet.
|
||||
* Open this site on your phone or tablet and… it just works!
|
||||
* Are you using a browser with **PWA support** (e.g. any Chromium-based
|
||||
browser)? Click on that little icon to the right of your location bar that says “Install SilverBullet” to give SB its own window frame and desktop icon, like it is a stand-alone app (not particularly useful on silverbullet.md, but definitely do this once you install it yourself).
|
||||
|
||||
Oh yeah, you can use fancy things like tables:
|
||||
|
||||
| Page | Comment |
|
||||
|----------|----------|
|
||||
| [[SilverBullet]] | Main product page |
|
||||
| [[CHANGELOG]] | The latest updates |
|
||||
|
||||
or code snippets, like JavaScript:
|
||||
|
||||
```javascript
|
||||
function helloWorld() {
|
||||
return "Hello there!"
|
||||
}
|
||||
```
|
||||
|
||||
or YAML:
|
||||
|
||||
```yaml
|
||||
name: SilverBullet
|
||||
rating: 5
|
||||
```
|
||||
|
||||
Click into any of these and edit them.
|
||||
|
||||
There are a few features you don’t get to fully experience in this environment, because they rely on a working back-end, such as:
|
||||
|
||||
* Using SB’s powerful page indexing and **query mechanism** where part of pages are automatically rendered and kept up to date by querying various data sources (such as pages and their metadata, back links, tasks embedded in pages, and list items) with an SQL like syntax, rendered with handlebars templates.
|
||||
* Intelligent **page renaming**, automatically updating any pages that link to it.
|
||||
* **Full text search**.
|
||||
* **Extending** and updating SB’s functionality by installing additional [[🔌 Plugs]] (SB parlance for plug-ins) and writing your own.
|
||||
|
||||
That’s all, now go install this baby already!
|
||||
|
||||
Instructions here 👉 [[SilverBullet]]
|
||||
@ -2,14 +2,16 @@ SilverBullet aims to be your **workshop for the mind**: a creative [[Space]] whe
|
||||
|
||||
While you _can_ use SilverBullet as a simple note taking application that stores notes in plain [[Markdown]] files on disk, it becomes truly powerful in the hands of more technical power users. By leveraging [[Metadata]] annotations, its [[Objects]] infrastructure, [[Live Queries]] and [[Live Templates]], SilverBullet becomes a powerful _end-user programming tool_, enabling you to quickly develop various types of ad-hoc knowledge applications.
|
||||
|
||||
SilverBullet is implemented as an open-source, self-hosted, offline-capable web application.
|
||||
SilverBullet is implemented as an _open-source_, _self-hosted_, _offline-capable_ web application (PWA).
|
||||
|
||||
You’ve been told there is _no such thing_ as a [silver bullet](https://en.wikipedia.org/wiki/Silver_bullet). You were told wrong.
|
||||
You’ve been told there is _no such thing_ as a [silver bullet](https://en.wikipedia.org/wiki/Silver_bullet).
|
||||
|
||||
## Quick links
|
||||
You were told wrong.
|
||||
|
||||
# Quick links
|
||||
* [[Install]]: how to install and deploy SilverBullet
|
||||
* [[Manual]]: the beginnings of a user manual
|
||||
* [[CHANGELOG]]: SilverBullet is in very active development, so things change rapidly. Watch this to see what’s new and changed.
|
||||
* [[CHANGELOG]]: SilverBullet is in active development, so things change rapidly. Watch this to see what’s new and changed.
|
||||
* Development:
|
||||
* [Roadmap](https://github.com/orgs/silverbulletmd/projects/2/views/1): currently planned features and priorities
|
||||
* [Issues](https://github.com/silverbulletmd/silverbullet/issues): if you have ideas, or find bugs, please report them
|
||||
@ -18,7 +20,7 @@ You’ve been told there is _no such thing_ as a [silver bullet](https://en.wiki
|
||||
* [Mastodon](https://fosstodon.org/@silverbulletmd): Follow SilverBullet development on [Mastodon](https://joinmastodon.org/)
|
||||
* [Discord](https://discord.gg/EvXbFucTxn): For more real-time support and discussion, join our Discord!
|
||||
|
||||
## Features
|
||||
# Features
|
||||
So, what does this thing do anyway?
|
||||
|
||||
SilverBullet...
|
||||
@ -39,7 +41,7 @@ To get a good feel of what SilverBullet is capable of, have a look at this (slig
|
||||
```embed
|
||||
url: https://youtu.be/BbNbZgOwB-Y
|
||||
```
|
||||
## Try it
|
||||
# Try it
|
||||
Here’s the kicker:
|
||||
|
||||
==You are looking at a (more or less) operational copy of SilverBullet **right now**==.
|
||||
@ -85,7 +87,7 @@ name: SilverBullet
|
||||
rating: 5
|
||||
```
|
||||
|
||||
## Going deeper
|
||||
# Advanced features
|
||||
Where things get _really_ interesting is when using features like [[Live Queries]] that allow you to query all types of [[Objects]] indexed based on the pages in your [[Space]].
|
||||
|
||||
Let’s explore this with a meta example of using this functionality for this very website. All pages in this space that represent a [[🔌 Plugs|plug]] are tagged with the `#plug` tag. Now, if we would want to render a list of all plugs in one place using the [[template/plug]] template, we can simply do this:
|
||||
@ -103,13 +105,10 @@ link where page = "{{@page.name}}" select toPage as name render [[template/page]
|
||||
```
|
||||
The sky is the limit. See [[Objects]] and [[Live Queries]] for more information.
|
||||
|
||||
## Install SilverBullet
|
||||
# Install SilverBullet
|
||||
Has your mind been sufficiently blown to commit to an install? Took you long enough, alright then. Please proceed to [[Install]] and enjoy!
|
||||
|
||||
## Where to go from here
|
||||
Have a lock at our work-in-progress [[Manual]].
|
||||
|
||||
## Support
|
||||
# Support
|
||||
If you (hypothetically) find bugs or have feature requests, post them in [our issue tracker](https://github.com/silverbulletmd/silverbullet/issues). Want to contribute? [Check out the code](https://github.com/silverbulletmd/silverbullet).
|
||||
|
||||
Want to chat with us? [Join our Discord](https://discord.gg/EvXbFucTxn)!
|
||||
Loading…
Reference in New Issue
Block a user