Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mgmeyers committed Apr 13, 2021
1 parent bc0220b commit 4524cb1
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This plugin allows snippet, theme, and plugin CSS files to define a set of configuration options. It then allows users to see all the tweakable settings in one settings pane. Style Settings allows both toggling classes on and off the `body` element, as well as setting numeric, string, and color CSS variables.

**[This CSS Snippet](obsidian-default-theme.css) can be used to adjust every CSS variable of the default Obsidian theme.**

Configurable settings are defined by comments within CSS files beginning with `/* @settings`. These comments must contain YAML with `name`, `id`, and `settings` properties. Style Settings will scan all CSS loaded by Obsidian for these comments.

For example, adding this to a CSS snippet in your vault:
Expand Down Expand Up @@ -37,9 +39,6 @@ will result in:

<img src="https://raw.githubusercontent.com/mgmeyers/obsidian-style-settings/main/screenshots/example01.png" alt="Example output of plugin" />


See [here](https://github.com/mgmeyers/obsidian-california-coast-theme/blob/main/src/000-css-settings.css) for a more detailed example taken from the [California Coast Theme](https://github.com/mgmeyers/obsidian-california-coast-theme).

Each setting definition must be separated by a dash (`-`). There are 7 setting types.

All settings definitions must have these parameters:
Expand Down

0 comments on commit 4524cb1

Please sign in to comment.