obsidian-theme/darkings_Obsidian-MonokaiSyntax
1
0
Fork 0
mirror of https://github.com/darkings/Obsidian-MonokaiSyntax.git synced 2026-07-22 04:40:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
darkings_Obsidian-MonokaiSy.../DEVELOPMENT.md
Darkings 642baf029a chore: 清理 AI 署名痕迹
2026-05-14 10:55:19 +08:00

2.3 KiB
Raw Permalink Blame History

Development

This document is for contributors and local theme development. User-facing installation notes live in README.md.

Requirements

  • Node.js
  • npm
  • Obsidian 1.0.0 or later

Setup

Clone the repository and install dependencies:

git clone https://github.com/Darkings/Obsidian-MonokaiSyntax.git
cd Obsidian-MonokaiSyntax
npm install

Common Commands

Run a production build:

npm run build

Run the SCSS linter:

npm run lint:css

Run CSS quality checks:

npm run check:contrast
npm run audit:css

Verify generated theme details:

npm run verify:icons
npm run verify:graph
npm run verify:active-visual

Run the full pre-release check:

npm run release:pack

Watch Build

Use watch mode while editing SCSS:

npm run dev

Vault Sync

Build and sync the theme to the default Obsidian vault:

npm run build:vault

Build and sync to a custom vault:

npm run build:vault -- D:/your/Obsidian/Vault

The script writes theme files to:

Target Vault/.obsidian/themes/Monokai Syntax/

Then enable Monokai Syntax from Obsidian's Appearance settings.

Generated Icons

The icon stylesheet is generated from the local icon font source:

npm run generate:icons

The same generator runs automatically before npm run build and npm run lint:css.

Project Structure

src/main.js                         # Vite entry
src/scss/index.scss                 # SCSS module entry
src/scss/_variables.scss            # Design tokens
src/scss/_base.scss                 # Obsidian CSS variable mapping
src/scss/components/                # Core UI surfaces
src/scss/plugins/                   # Plugin-specific styling
src/css/style-settings/             # Style Settings metadata blocks
scripts/                            # Build, verification, and sync scripts
dist/theme.css                      # Built theme CSS
theme.css                           # Root theme CSS for Obsidian packaging
manifest.json                       # Obsidian theme manifest

Runtime Asset Rule

The final theme CSS must not load remote runtime assets. Do not use remote @import, remote font URLs, or remote image URLs. Fonts, icons, and image assets must be local and license-checked.