GithubHelp home page GithubHelp logo

geekwolverine / catppuccin-theme-vscode Goto Github PK

View Code? Open in Web Editor NEW

This project forked from catppuccin/vscode

0.0 1.0 0.0 4.87 MB

Home Page: https://marketplace.visualstudio.com/items?itemName=Catppuccin.catppuccin-vsc

License: MIT License

Shell 0.06% JavaScript 1.02% TypeScript 98.92%

catppuccin-theme-vscode's Introduction

Logo
Catppuccin for VSCode

Previews

🌻 Latte
🪴 Frappé
🌺 Macchiato
🌿 Mocha

Usage

Preferred method of installation

Install the extension from a Marketplace:

Manual method for installation

Download the VSIX from the latest GitHub release. Open the Command Palette, and select "Extensions: Install from VSIX...", then open the file you just downloaded.

Note
It is recommended to change window.titleBarStyle to custom in your JSON user settings.

Using the JSON theme only

You can find the compiled theme JSON files (with default settings as documented below) on the compiled branch.

Customization

Catppuccin for VSCode can be customized to your liking. If you like the Catppuccin colours, but feel that they are a bit too bright for working at night, customization got you covered!

oldeppuccin-pink-accent

⚙️ Used settings

     // use Mocha as the base
    "workbench.colorTheme": "Catppuccin Mocha",
    // pink as the accent colour
    "catppuccin.accentColor": "pink",
    // make Mocha specifically very dark
    // (this preserves other flavours!)
    "catppuccin.colorOverrides": {
        "mocha": {
            "base": "#000000",
            "mantle": "#010101",
            "crust": "#020202",
        }
    },
    // use your accent (pink) on the statusBar as well
    "catppuccin.customUIColors": {
        "mocha": {
            "statusBar.foreground": "accent"
        }
    },

Open your settings, and look for Extensions > Catppuccin. Available options are documented here.

Custom accent colour

catppuccin.accentColor

You can choose any colour as your "accent" colour. mauve is our default, but you can add more personality by using your favourite!

Disable italics & bold fonts

You can toggle whether to use

  • italics for keywords: catppuccin.italicKeywords
  • italics for comments: catppuccin.italicComments
  • bold for keywords: catppuccin.boldKeywords

Flat appearance

catppuccin.workbenchMode

By default, Catppuccin for VSCode uses 3 shades of our base colour for the workbench. For example in Mocha:

  • base: #1e1e2e - the editor background
  • mantle: #181825 - the sidebar
  • crust: #11111b - the activity bar, status bar and title bar

If you'd like a more flat look, you can change it to flat! This only uses base and mantle, reducing it to 2 shades:

  • base: #1e1e2e - the editor background
  • mantle: #181825 - the sidebar, the activity bar, status bar and title bar
📸 Preview

flat appearance

Paired Brackets

catppuccin.bracketMode

By default we're using red, peach, yellow, green, blue, and mauve for matching bracket pairs. You can change that option, if you want different colors:

  • rainbow is our default setting, using the colors described above.
  • dimmed uses the same rainbow colors, but muted by 20%.
  • monochromatic only uses greyish colors, from subtext1 to surface2.
  • neovim uses the same colors that nvim-ts-rainbow uses in our Neovim port.

Override palette colours

catppuccin.colorOverrides

Colours can be overwritten in the JSON user settings, like so:

    // ...your other settings...
    "catppuccin.colorOverrides": {
        // make text red red all flavours
        "all": {
            "text": "#ff0000"
        },
        // make Mocha "OLEDppuccin" - use black editor background
        "mocha": {
            "base": "#000000",
            "mantle": "#010101",
            "crust": "#020202",
        }
    }

Use palette colours on workbench elements (UI)

catppuccin.customUIColors

If you want to customize where certain palette colours appear, you can change it like so:

    "catppuccin.customUIColors": {
        // make the breadcrumb "text" on "overlay0" for all flavours
        "all": {
            "breadcrumb.background": "overlay0",
            "breadcrumb.foreground": "text",
        },
        // but for mocha, use "crust" on your currently selected accent.
        "mocha": {
            // "accent" selects your current accent colour.
            "breadcrumb.background": "accent",
            "breadcrumb.foreground": "crust",
            // you can use opacity, by specifing it after a space
            // "rosewater 0.5" would mean 50% opacity, here it's 20%
            "minimap.background": "rosewater 0.2"
        }
    },

You can find all the available keys here.

Note: This respects your colour overrides.

Support

If you have any questions regarding this port, feel free to open an issue, or ask in our Discord, where have a dedicated forum for support.

Development

  1. Clone and open this repository in VSCode.
  2. Launch a new instance from "Run and Debug". This will spawn a new instance, which will have the current build of the Theme available.
  3. Make modifications to the JSONs in ./themes to see the changes immediately.
  4. To preserve changes, they have to be edited in ./src/theme/*.ts, since the theme builds the JSONs from there.

💝 Thanks to

 

Copyright © 2021-present Catppuccin Org

catppuccin-theme-vscode's People

Contributors

adamdotjs avatar aproposts avatar brunderschwarzmagier avatar camblomquist avatar ghostx31 avatar gingeh avatar joriswvanrijn avatar mangeshrex avatar nekowinston avatar nullchilly avatar pocco81 avatar sgoudham avatar suppayami avatar victortennekes avatar watatomo 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.