Welcome to the Obsidan-Styles wiki!

This contains details about using the Obsidian Styles Repo in your own Obsidian Project. Currently the project contains the following directories:

• src - Which contains a collection of common css snippets I use. You can read about the CSS Snippets system in the Obsidian Docs
• scripts - Which contains a collection of scripts that I use with the Templater plugin to further automate my notebook
• templates - Contains a collection of templates I like using. Most which are tied to a script.

For Javascript and Templates I am using 2 plugins in my Obsidian Vaults:

1. Templater - Needed to drive the execution of the Templates and Javascript
2. Dataview - Needed to drive the "Component" templates as well as dynamic list/table generation inside of templates.

It is recommend you install both of these in your Vault if you are using this repository.

I have provided a couple of options for setting up in Obsidian. For convenience, I have created a loader script which you can download using:

curl -s https://raw.githubusercontent.com/tkottke90/Obsidan-Styles/main/bin/load.sh -o load.sh | bash

This command will take care of setting up the repository on your device and will automatically start the setup process for the repository. The script will be added to your user's home directory (typically /Users/<username>) on your device under the .obsidian-styles directory.

If you do not trust my script (and I do not blame you), the next easiest is to go to the releases page and download the latest tar file. This tarfile contains all the files in the dist directory. You can then put your scripts, snippets, and templates where you need them.

If you wish to build from source or fork this repo, you can also download the repo using git.

The files have already been built. To set this up on your computer, first clone the repo:

git clone https://github.com/tkottke90/[email protected]

Then simply run the deploy command:

npm run deploy

If it is your first time running the script you will prompted to provide your Obsidian vault location.

$ npm run deploy
@tkottke90/[email protected] deploy
source ./bin/deploy.sh

What is the location of your Obsidian Vault? 

The script will create a .obsidian file in the root directory so that you wont be asked again

This script will copy the files from the dist directory to the .obsidian/snippets folder inside of your Vault directory. If you have not already created this folder, it will be created for you.