Website content updates

This commit is contained in:
Zef Hemel
2023-11-15 09:31:52 +01:00
parent b4ab56c712
commit 4acfd96011
10 changed files with 260 additions and 153 deletions
+59
View File
@@ -0,0 +1,59 @@
The idea of markdown is that you write plain text with some additional markup that even without further processing (like rendering it to HTML, or [[Live Preview]]) you could just read and understand. It was inspired by conventions used in plain-text e-mails, before e-mail supported rich formatting.
### Basic markup
So to write markdown, you just write text. But then to emphasize something you can add `_underscores_` around a phrase to make look _italic_, or `**asterisks**` to make it **bold**. You can also use `~~tildes~~` for ~~strikethrough~~ and `==double equals==` for ==highlighting==.
### Links
To add external links you use the `[site link](https://silverbullet.md)` syntax, which will appear as [site link](https://silverbullet.md). If you want to link to other pages in your space you use the `[[wiki link syntax]]`, e.g. [[SilverBullet]]. To change the link text you can use the `[[SilverBullet|best PKM evah]]` syntax: [[SilverBullet|best PKM evah]].
## Lists and tasks
You can create three types of lists:
Unordered lists are created by prefixing a line with `*` or `-`. For instance:
* This is an unordered list
* And this is a second item
Since this tool is called SilverBullet, we prefer you to use the `*` bullet (which will even appear in _silver_ — clever huh?).
Ordered lists are created by simply putting a number follow by a period at the beginning of a line:
1. This is the first item
2. This is the second item
SilverBullet also supports a variant of the unordered list item to define task. Tasks are defined using the `* [ ] Task name` syntax:
* [ ] This is a task
* [ ] And this is another
When you click the checkbox, it will toggle its state and replace the ` ` inside the box with `x`. SilverBullet also supports custom task statuses by putting text in between `[` and `]`. When you click on such custom task states, it will cycle through all the task states its seen in your space:
* [IN PROGRESS] This task is in progress
* [DONE] This task is done
* [TO DO] This task is still to be done
## Headers
Markdown supports various levels of headings, which generally are created by prefixing a line with one or more `#`. The more `#`s the deeper the header nesting.
## Quotes
You can use block quotes by prefixing lines with `>`:
> “If you dont know where youre going, you may not get there.”
> — Yogi Berra
## Code
For the programmers among us, theres three ways to mark up code. If you want to write some code inline, you can use backticks: `this is code`. For long code snippets you can either use a four-space indent:
This is code
And another line
Or (preferably) the triple-back tick notation, which also allows you to (optionally) specify a coding language:
```javascript
function hello() {
return "sup";
}
```
SilverBullet supports [[Markdown/Syntax Highlighting]] for many languages out of the box.
+16
View File
@@ -0,0 +1,16 @@
In addition to supporting [[Markdown/Basics|markdown basics]] as standardized by [CommonMark](https://commonmark.org/), SilverBullet relies on the following extensions:
* Double-bracketed wiki links: `[[link to page]]`, optionally with aliases `[[link to page|alias]]`.
* [[Frontmatter]] and [[Attributes]]
* [Fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks), and in addition, assigning new meanings to specific fenced code block languages:
* Generically via [[Markdown/Code Widgets]]
* [[Live Queries]]
* [[Live Templates]]
* [[Anchors]]
* Hashtags, e.g. `#mytag`.
* Command link syntax: `{[Stats: Show]}` rendered into a clickable button {[Stats: Show]}.
* [Tables](https://www.markdownguide.org/extended-syntax/#tables)
* [Task lists](https://www.markdownguide.org/extended-syntax/#task-lists)
* [Highlight](https://www.markdownguide.org/extended-syntax/#highlight)
* [Automatic URL linking](https://www.markdownguide.org/extended-syntax/#automatic-url-linking)
* Any addition custom markdown extensions provided by [[🔌 Plugs]]