No description
Find a file
2025-03-19 16:59:44 +01:00
.github chore: initialize plugin 2025-03-18 17:51:58 +01:00
docs docs: update image paths in README and snippets for consistency 2025-03-19 13:37:37 +01:00
hooks Initial commit 2024-11-26 21:13:47 +01:00
src refactor: remove debug console log from main.ts 2025-03-19 16:59:33 +01:00
tests feat: add TypeScript types for Bun and implement tests for CSS variable generation 2025-03-19 12:56:30 +01:00
.editorconfig Initial commit 2024-11-26 21:13:47 +01:00
.gitignore Initial commit 2024-11-26 21:13:47 +01:00
.npmrc Initial commit 2024-11-26 21:13:47 +01:00
biome.json chore: initialize plugin 2025-03-18 17:51:58 +01:00
bun.lock feat: add TypeScript types for Bun and implement tests for CSS variable generation 2025-03-19 12:56:30 +01:00
CHANGELOG.md chore(release): 0.0.5 2025-03-19 16:59:44 +01:00
commit-and-tag-version.mjs Initial commit 2024-11-26 21:13:47 +01:00
esbuild.config.mjs chore: initialize plugin 2025-03-18 17:51:58 +01:00
LICENSE chore: initialize plugin 2025-03-18 17:51:58 +01:00
manifest-beta.json chore(release): 0.0.5 2025-03-19 16:59:44 +01:00
manifest.json chore(release): 0.0.5 2025-03-19 16:59:44 +01:00
package.json chore(release): 0.0.5 2025-03-19 16:59:44 +01:00
README.md docs: update image paths in README and snippets for consistency 2025-03-19 13:37:37 +01:00
tsconfig.json feat: add TypeScript types for Bun and implement tests for CSS variable generation 2025-03-19 12:56:30 +01:00
version-bump.mjs Initial commit 2024-11-26 21:13:47 +01:00
versions.json Initial commit 2024-11-26 21:13:47 +01:00

Simple Colored Folder

Automagically add color to root folder, and customize it with Style Settings.

tree with colored folders

📦 Features

  • Automatically applies variables & colors to root-level folders in your vault
  • Customizable colors for each folder through style settings
  • Custom styling options through template
  • Folder style changes update in real-time
  • Supports both light & dark themes

Warning

This plugin requires the Style Settings plugin to customize folder colors. You'll see a warning if Style Settings isn't installed.

⚙️ Usage

  1. Install the plugin
  2. Make sure you also have the Style Settings installed & enabled.
  3. Access Style settings to customize your folder color.
  4. Under the "Simple Colored folder" section, you can change colors for each root folder.

style settings

🎨 Configuration

In the plugin settings, you can customize :

  • Folder name prefix for CSS varaible
  • Custom CSS templates
  • Custom style settings template

settings

Note

You can see some example of css template here

📥 Installation

  • From Obsidian's community plugins
  • Using BRAT with https://github.com/Mara-Li/obsidian-simple-colored-folder
  • From the release page:
    • Download the latest release
    • Unzip simple-colored-folder.zip in .obsidian/plugins/ path
    • In Obsidian settings, reload the plugin
    • Enable the plugin

🎼 Languages

  • English
  • French

To add a translation:

  1. Fork the repository
  2. Add the translation in the src/i18n/locales folder with the name of the language (ex: fr.json).
    • You can get your locale language from Obsidian using obsidian translation or using the commands (in templater for example) : <% tp.obsidian.moment.locale() %>
    • Copy the content of the en.json file in the new file
    • Translate the content
  3. Edit i18n/i18next.ts :
    • Add import * as <lang> from "./locales/<lang>.json";
    • Edit the ressource part with adding : <lang> : {translation: <lang>}