Giter Club home page Giter Club logo

sassyzed's Introduction

SCSS Zed Theme Compiler

This package allows you to write Zed themes with SCSS.

It's a quick-and-dirty utility that compiles a SCSS file into a Zed JSON theme file, allowing you to develop in SCSS and take advantage of features like color variables.

Sassy Zed

Setup

  1. This utility requires Node.js to run, so you'll need to make sure that is installed on your local system.
  2. Clone this repo and run npm install to install dependencies.

Theme development

  1. Give your theme a name: Inside the src folder is an example theme file to get started. Edit its name to make it easy to choose from the list of themes in Zed.
  2. Start the compiler: Run npm run dev to compile and install the theme.
  3. Select your theme: Navigate to the Zed themes menu and choose your theme.
  4. Develop: Any changes to your scss file will automatically reflect in Zed, so you can see your changes in real-time.
  5. Press ^c in the terminal to stop the compiler.

Theme publishing

  1. Run npm run build to compile your theme.
  2. Grab the JSON file from the dist folder to use in your theme extension.
  3. Follow the instructions provided by Zed for publishing themes.

Quirks

  • CSS var prefixes (--) are stripped from the JSON output.
  • Dashes (-) are replaced with periods (.) in the JSON output.
  • Because this utility uses CSS vars to define values, SCSS variables need to be wrapped in #{} tags to be evaluated correctly.

sassyzed's People

Contributors

bryanbuchanan avatar

Stargazers

Kainoa Kanter avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.