Skip to content

vran-dev/obsidian-composer

Repository files navigation

中文 | English

Brief

an out-of-box theme for Obsidian, which is designed for reading and writing comfortably.

Screenshots

You can install style settings plugin and change the theme color in the plugin setting.

Color Scheme

Note

color scheme change needs to install style settings plugin

  • Xiá 霞

xia light

xia dark

  • Sù 素

su light

su dark

  • Qīng 青

qing light

qing dark

Text Formatting

text formatting

Table Style

table style

Callout Style

callout style

Thanks

  • Task checkbox is referenced from Minimal Theme which is a great theme for Obsidian build by @Kepano

Development Workflow (settings.yml + composer.css Split)

This theme now separates the Style Settings YAML header from the CSS for better editor support.

Files:

  • settings.yml – Pure YAML (no wrapping comment). Edit Style Settings options here.
  • composer.css – Pure CSS body (without the initial /* @settings ... */ block).
  • build.mjs – Build script that merges the two into theme.css.

Usage:

  1. Edit style settings in settings.yml.
  2. Edit styles in composer.css.
  3. Run npm run build to generate theme.css.
  4. Load or distribute theme.css as the final theme file.

Release Flow: npm version patch|minor|major will automatically:

  1. Run preversion (which triggers npm run build).
  2. Bump version and stage manifest.json, versions.json, and theme.css.

Notes:

  • Do NOT manually edit the YAML inside theme.css; it will be regenerated.
  • Only add/change settings in settings.yml.
  • The build script strips an optional leading comment block from composer.css before concatenation.

Future Enhancements (Optional):

  • YAML schema validation (e.g. with js-yaml) to catch structural errors.
  • Skip rewriting theme.css when no changes occur (quieter diffs).
  • Support multiple YAML fragments under a settings/ directory auto-merged at build time.

Rollback to single file (if desired):

  1. Run npm run build.
  2. Keep resulting theme.css.
  3. Remove settings.yml, composer.css, and build.mjs.

Feel free to open an issue if you’d like these enhancements implemented.

About

simple and pretty theme for obsidian & components plugin

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 6