3. OpenGist.md

This section explains how to integrate Opengist into your Obsidian.md notes

What is OpenGist?

OpenGist is a self-hosted solution that works in a similar manner to Github Gists, but with the added bonus that you control the entire site. It is great for private gist hosting, and also supports other users being able to register on your site and host their own gists. It also includes its own API, and is compatible with Github CLI (command-line)

This guide will not go into detailed instructions on how to install and configure an OpenGist server, however, you can use the buttons below for a very detailed set of instructions for getting started with your own self-hosted gist solution.

OpenGist currently supports hosting your own gist server on

Windows
MacOS
Linux

A list of useful links are provided below:

Using Gistr with OpenGist (Examples)

The following examples show you how to integrate an OpenGist snippet into your notes.

Single Gist

This is a single note specified by the base URL associated with your Github Gist snippet.

```gistr
url:    https://demo.opengist.io/Aetherinox/5c52113c9286474589f1a29386c27cb3
```

```gistr
https://demo.opengist.io/Aetherinox/5c52113c9286474589f1a29386c27cb3
```

https://demo.opengist.io/Aetherinox/5c52113c9286474589f1a29386c27cb3

Multiple Gists

This example shows a gist which has multiple files associated to it.

```gistr
url:    https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba
```

```gistr
https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba
```

https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba

Multiple Gist (Select One)

Important

Currently, OpenGIst does not support picking out a particular file from a gist that hosts multiple. I am working with the developer to integrate this feature.

Theme Override

In the Gistr Settings tab, you can select which theme you wish to use

Light
Dark

However, if you wish to force a particular theme for only one gist, you can append &themename on the end of your gist url. Replacing themename with either dark or light.

Light

You can use the light theme by appending &light to the end of your URL. IE: https://demo.opengist.io/Aetherinox/0f0cafd0b9474041a228dc2d41e86946&light

```gistr
url:    https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba
theme:  light
```

```gistr
https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba&light
```

https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba&light

Dark

You can use the dark theme by appending &dark to the end of your URL. IE: https://demo.opengist.io/Aetherinox/0f0cafd0b9474041a228dc2d41e86946&dark

```gistr
url:    https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba
theme:  dark
```

```gistr
https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba&dark
```

https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba&dark

Gist Error

This will display when the URL you have specified is invalid.

https://demo.opengist.io/Aetherinox/5bd5a23ed9cc434bb8079f5ddceee8ba3

Aetherinox/3. OpenGist.md