silverbullet/website/Manual.md

45 lines
1.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

Welcome to wonderful world of SilverBullet. The goal of this manual is to give you a broad sense of how to use this tool and what its 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 lets give you a bit of a sense.
> **warning** Warning
> This manual is **very** much a work in progress.
# Keeping up-to-date
* [[CHANGELOG]]: whats new in SilverBullet? This page will give you the latest details. Its worth monitoring this page, especially if something broke for you.
# 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
* [[Deployments]]: various deployment options
* [[Authelia]]: configuring SilverBullet with [Authelia](https://www.authelia.com/) authentication.
* [[Guide/Deployment/Cloudflare and Portainer]]: configuring SilverBullet with a Cloudflare tunnel, portainer and optional Cloudflare zero trust authentication.
# User interface
* [[Manual/Page Picker]]
* [[Manual/Command Palette]]
* [[Client Modes]] (that sync button)
# Core Concepts
These are some
* [[Spaces]]
* [[Pages]]
* [[Frontmatter]]
* [[Folders]]
* [[Attachments]]
* [[Templates]]
# Editing and Formatting
* [[Markdown]]
* [[Markdown/Syntax Highlighting]]
* [[Markdown/Code Widgets]]
* [[Manual/Outlines]]
* [[End-User Programming]]
* [[Objects]]
* [[Frontmatter]]
* [[Attributes]]
* [[Live Queries]]
* [[Live Templates]]
* [[SETTINGS]]: A few settings you can tweak