Zef Hemel
34557e0575
- Revised multiple documentation files to correct references and improve clarity, including updates to the Command Palette, Document Editor, and various Markdown files. - Removed outdated references to "Slash Templatese" and replaced them with "Slash Templates" for consistency. - Enhanced explanations regarding meta pages and shortcuts, ensuring accurate guidance for users.
2.7 KiB
Welcome to the wonderful world of SilverBullet. The goal of this manual is to give you a broad sense of how to use this tool and what it’s capable of. However, its full capabilities are yet to be discovered. You too may find new and creative ways to use the various SilverBullet features in ways nobody previously thought of.
However, that is all unlikely to happen unless you understand what SilverBullet can actually do. So let’s give you a bit of a sense.
Keeping up-to-date
- CHANGELOG: what’s new in SilverBullet? This page will give you the latest details. It’s worth monitoring this page.
Installation and deployment
The biggest hurdle to get over with SilverBullet is that you need to get this thing running. And as of yet, the only way to do that is to install and deploy it yourself. 🤷
- Install: Installation instructions for various setups
For more additional guides, check out our community guides.
User interface
SilverBullet’s UI is minimalist by design. Let’s look at the few UI elements and how to use them.
- The Top Bar contains:
- Page Namer
- Index Page (the 🏠 button)
- Page Picker
- Command Palette
- The main Editor component contains your currently selected page’s text
Core Concepts
These are the core concepts used in SilverBullet:
Editing and Formatting
- Content is written using Markdown and rendered using Live Preview
- Slash Commands
- Outlines
Navigation
The main ways to roam your space, beside following page links, are:
Advanced topics
Customization
Extending SilverBullet
SilverBullet’s implementation is built on three things:
- The core is implemented as a TypeScript-based web app
- A lot of core functionality is implemented in Plugs.
- An increasing amount of additional functionality is now being implemented in “native” Space Lua.
Contributing
SilverBullet is free and open-source software. You can contribute to it via Github. For some details on how to do this, have a look at Development.