From 806ec71c28342fac949bc4ef2bf6949bfb492da9 Mon Sep 17 00:00:00 2001 From: Aetherinox Date: Sat, 30 Mar 2024 12:29:47 -0700 Subject: [PATCH] docs: update --- docs/docs/usage/raw-mode.md | 54 +++++++++++++++++++++++++++++++++++++ docs/mkdocs.yml | 1 + 2 files changed, 55 insertions(+) create mode 100644 docs/docs/usage/raw-mode.md diff --git a/docs/docs/usage/raw-mode.md b/docs/docs/usage/raw-mode.md new file mode 100644 index 00000000..743cd9a8 --- /dev/null +++ b/docs/docs/usage/raw-mode.md @@ -0,0 +1,54 @@ +--- +title: "Using Raw Mode" +tags: + - usage +--- + +# Raw Mode +Setting a codeblock to run in `raw mode` is a unique feature introduced in [v1.6.0](../changelog.md#160-march-29-2024--id160). + +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. + +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. + +!!! note annotate "Website Support" + + `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. + +
+ +## Cookies & Sign-in +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. + +
+ +## Enabling Raw Mode +To switch your codeblock from a normal text codeblock over to raw mode; you must structure your codeblock in the following manner: + +```` +```gistr +url: https://gist.github.com/Aetherinox/f7525990fba2cba6a3ee7b61ac626c21 +raw: true +zoom: 0.8 +height: 500 +``` +```` + +
+ +## Additional Properties +Along with specifying `raw`, you also have access to the properties: + +- `zoom` +- `height` + +
+ +| Property | Description | +| --- | --- | +| [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`| +| [height](../usage/properties.md#property-height) | _**(Raw Mode Only)**_: Specify the height of the window when displaying a gist. | + +
+ +Detailed information on these properties can be found on the [Properties](../usage/properties.md) page. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ed2006de..9ced13a5 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -158,6 +158,7 @@ nav: - Usage: - Basic: 'usage/basic.md' - Properties: 'usage/properties.md' + - Raw Mode: 'usage/raw-mode.md' - Settings: - Summary: 'settings/summary.md' - Global: 'settings/global.md'