Skip to content

Commit 806ec71

Browse files
committed
docs: update
1 parent 64212d2 commit 806ec71

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

docs/docs/usage/raw-mode.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: "Using Raw Mode"
3+
tags:
4+
- usage
5+
---
6+
7+
# Raw Mode
8+
Setting a codeblock to run in `raw mode` is a unique feature introduced in [v1.6.0](../changelog.md#160-march-29-2024--id160).
9+
10+
It allows you to display a gist in a web-browser environment instead of as a simple codeblock. This is useful for gists which include mermaid graphs.
11+
12+
Github has configured gists to require numerous javascript files in order to navigate the graph and view the data; which cannot be obtained through conventional methods that are used for normal codeblocks / text. Whereas raw mode allows for these javascript files to be loaded locally in your Obsidian notes.
13+
14+
!!! note annotate "Website Support"
15+
16+
`Raw Mode` was specially developed as a way to display gists with mermaid graphs; however, raw mode will actually work for any website on the internet being displayed.
17+
18+
<br />
19+
20+
## Cookies & Sign-in
21+
Raw mode allows you to view a full version of the specified website; which means you also have the option to sign into websites such as Github just as you would in a normal browser. This gives you access to not only view your gists, but also edit them, as well as view any other content available on Github or your Opengist website.
22+
23+
<br />
24+
25+
## Enabling Raw Mode
26+
To switch your codeblock from a normal text codeblock over to raw mode; you must structure your codeblock in the following manner:
27+
28+
````
29+
```gistr
30+
url: https://gist.github.com/Aetherinox/f7525990fba2cba6a3ee7b61ac626c21
31+
raw: true
32+
zoom: 0.8
33+
height: 500
34+
```
35+
````
36+
37+
<br />
38+
39+
## Additional Properties
40+
Along with specifying `raw`, you also have access to the properties:
41+
42+
- `zoom`
43+
- `height`
44+
45+
<br />
46+
47+
| Property | Description |
48+
| --- | --- |
49+
| [zoom](../usage/properties.md#property-zoom) | _**(Raw Mode Only)**_: Determines how big the content and text will appear in the gist window. Default value: `1`. 50% would be `0.5`|
50+
| [height](../usage/properties.md#property-height) | _**(Raw Mode Only)**_: Specify the height of the window when displaying a gist. |
51+
52+
<br />
53+
54+
Detailed information on these properties can be found on the [Properties](../usage/properties.md) page.

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@ nav:
158158
- Usage:
159159
- Basic: 'usage/basic.md'
160160
- Properties: 'usage/properties.md'
161+
- Raw Mode: 'usage/raw-mode.md'
161162
- Settings:
162163
- Summary: 'settings/summary.md'
163164
- Global: 'settings/global.md'

0 commit comments

Comments
 (0)