1
0
silverbullet/website/Getting Started.md

56 lines
4.8 KiB
Markdown
Raw Permalink Normal View History

2024-01-20 21:53:51 +00:00
# Hello there!
Welcome to the wondrous world of SilverBullet. A world that once you discover and appreciate, youll never want to leave.
2024-01-20 21:53:51 +00:00
_One of us!_
2024-01-20 21:53:51 +00:00
Out of the box SilverBullet is fairly minimal in terms of functionality. To give you a good “first run” experience, we recommend you start by importing the [[Library/Core]] library into your space. This will give you a couple of useful pages, slash commands, page templates and widgets such as [[Table of Contents]] and [[Linked Mentions]] to start of with. If you have no idea what those are — dont worry about it. Just keep going, youll get the hang of things.
2024-01-20 21:53:51 +00:00
Just push this button: {[Library: Import|Import Core Library]("!silverbullet.md/Library/Core/")}
You know you want to.
Just do it.
# Next steps
Now that you have some basics stuff in place, its time to start playing a bit.
2023-01-16 11:06:37 +00:00
* Click on the page picker (book icon) icon at the top right, or hit `Cmd-k` (Mac) or `Ctrl-k` (Linux and Windows) to open the [[Page Picker]].
2023-01-16 11:06:37 +00:00
* Type the name of a non-existent page to create it.
2024-01-20 21:53:51 +00:00
* Folders are implicitly created by putting slashes (`/`) in the name (even on Windows), e.g. `My Folder/My Page`. Dont worry about folders existing, well automatically create them if they dont.
* Click on the terminal icon (top right), or hit `Cmd-/` (Mac) or `Ctrl-/` (Linux and Windows), or tap the screen with 3 fingers at the same time (on mobile) to open the [[Command Palette]]. From here you can run various useful and perhaps less useful [[Commands]]. The {[Stats: Show]} one is a safe one to try.
2023-01-16 11:06:37 +00:00
* Select some text and hit `Alt-m` to ==highlight== it, or `Cmd-b` (Mac) or `Ctrl-b` (Windows/Linux) to make it **bold**, or `Cmd-i` (Mac) or `Ctrl-i` (Windows/Linux) to make it _italic_.
2023-01-16 15:55:11 +00:00
* Click a link somewhere on this page to navigate there. When you link to a new page it will initially show up in red (to indicate it does not yet exist), but once you click it — you will create the page automatically (only for real when you actually enter some text).
* Start typing `[[` somewhere to insert your own page link (with completion).
2023-01-16 11:06:37 +00:00
* Start typing `:party` to trigger the emoji picker 🎉
* Type `/` somewhere in the text to invoke a **slash command**.
* If this is matching your personality type, you can click this button {[Editor: Toggle Vim Mode]} to toggle Vim mode. If you cannot figure out how to exit it, just click that button again. _Phew!_
2023-01-16 15:55:11 +00:00
Notice that as you move your cursor around on this page and you get close to or “inside” marked up text, you will get to see the underlying [[Markdown]] code. This experience is what we refer to as “live preview” — generally your text looks clean, but you still can see whats under the covers and edit it directly, as opposed to [WYSIWYG](https://en.wikipedia.org/wiki/WYSIWYG) that some other applications use. To move your cursor somewhere using your mouse without navigating or activating (e.g. a wiki, regular link, or a button) hold `Alt` when you click. Holding `Cmd` or `Ctrl` when clicking a link will open it in a new tab or window.
2023-01-16 15:55:11 +00:00
Hadnt we mentioned [[Markdown]] yet? Yeah, thats the markup language youll use to add that dash of markup to your documents. Its pretty simple to learn if you dont know it already.
2023-10-03 16:16:07 +00:00
You will notice this whole page section is wrapped in a strange type of block. This is a SilverBullet specific feature called a [[Live Templates]], which embeds another (sometime external) page into the existing one. If you hover over this section, youll notice a small _refresh_ and _edit_ button. Hit that edit button to reveal the underlying source that renders this content.
2023-01-16 11:06:37 +00:00
2023-10-03 16:16:07 +00:00
SilverBullet has even more tricks up its sleeve. Consider [[Live Queries]] which allow you to query [[Objects]] in your space easily.
2023-10-03 16:02:19 +00:00
Dont believe me? Check this out, heres a list of (max 10) pages in your space ordered by name, it updates (somewhat) dynamically 🤯. Create some new pages and come back here to see that it works:
2023-08-04 19:17:36 +00:00
```query
page select name order by name limit 10
```
2023-01-16 11:06:37 +00:00
## What next?
2024-01-20 21:53:51 +00:00
If you are a visual learner, you may [enjoy this introduction video on Youtube](https://www.youtube.com/watch?v=BbNbZgOwB-Y).
2023-01-17 08:45:10 +00:00
Beyond that, you can find more information about SilverBullet on its official website. You have two ways to access it:
2023-01-16 11:06:37 +00:00
1. Through its [regular website link](https://silverbullet.md/)
2. Directly without leaving SilverBullet, through [[Federation]], just click on this: [[SilverBullet]] (note that all of these will be read-only, for obvious reasons)
2024-01-20 21:53:51 +00:00
To keep up with the latest and greatest goings-on in SilverBullet land, keep an eye on the [[CHANGELOG]].
Got any more questions? Join our [community](https://community.silverbullet.md/).
Feel a bit more ready in this endeavor? If so, feel to remove the [[Live Templates|live template]] that renders this on-boarding description. Youre on your own now.
You got this.