| .claude | ||
| .github | ||
| dist | ||
| icons | ||
| scripts | ||
| src | ||
| test | ||
| .gitignore | ||
| CHANGELOG.md | ||
| ERRORS.md | ||
| LICENSE.md | ||
| manifest.json | ||
| MonokaiSyntax.png | ||
| package-lock.json | ||
| package.json | ||
| README.en.md | ||
| README.md | ||
| screenshot.png | ||
| stylelint.config.js | ||
| TODO.md | ||
| versions.json | ||
| vite.config.js | ||
Monokai Syntax
Monokai Syntax is a community theme for Obsidian that aims to reproduce the Monokai Pro dark and light visual language in knowledge management contexts.
Next Version Plan
- Polish project icons
- Refine project details
- Improve Style Settings plugin integration
Project Status
Currently in early development stage. The foundational engineering scaffolding, Vite build pipeline, Stylelint checks, and test vault sync workflow are complete.
Install Dependencies
npm install
Common Commands
Lint SCSS:
npm run lint:css
Build the theme:
npm run build
Build and sync to test vault:
npm run build:vault # Default vault
npm run build:vault -- D:/your/Obsidian/Vault # Custom vault
Local Testing
Default test vault path:
C:\Users\Jie\iCloudDrive\iCloud~md~obsidian\SecondBrain
To use your own vault, append the path to the command:
npm run build:vault -- D:/your/Obsidian/Vault
The theme files will be synced to .obsidian\themes\Monokai Syntax under the target vault.
You can then enable Monokai Syntax in Obsidian's Appearance settings.
Remote Resource Constraints
The theme CSS must not load remote resources at runtime. Remote @import, remote font URLs, or remote image URLs are prohibited in the final theme CSS. Any fonts, icons, or image assets must be localized and their licenses verified.
License
This project is licensed under the MIT License. See LICENSE.md for details.