Skip to content

A Builder for schemes and templates. Supports Base16, Base24, etc.

License

Notifications You must be signed in to change notification settings

tinted-theming/base16-builder-node

Repository files navigation

base16-builder-node Color wheel

latest version license open issues vulnerabilities

A builder for schemes and templates based on clear, universal style specifications. The output is app specific theming configurations. Build a color scheme once, use it everywhere.

Features

What is a style specification?

A specification details palette architecture and how it should be used for rendering application UI or syntax highlighting. Real life implementations of a style specification typically include a color scheme and app templates.

Supported specifications

  • Base16 - an architecture of carefully chosen syntax highlighting using a base of just sixteen colors.
  • Base24 - Base16 plus an additional 8 colors to allow using all 16 ANSI colors in the terminal.

Install

npm install -g base16-builder-node

This package provides a base16 console command. Invoke it from any directory you want to build your themes, templates, and schemes in.

Basic Usage - Base16 example

Your working directory will need the following substructure:

  • base16/schemes
  • base16/templates
cd working_dir
mkdir -p base16/templates && cd base16
git clone https://github.com/tinted-theming/base16-schemes.git schemes
cd templates
git clone [your template of choice]
git clone [another template of choice]
cd ../..
base16 build base16 --prefix base16-

Builds all templates found in base16/templates using all scheme files from base16/schemes applying the base16- prefix to each.

Build Assets

The theme files will be generated inside every template directory in the subdirectory specified by that template's configuration.

For example: textmate. The built files would be found at:

./templates/textmate/Themes,

If you are a template maintainer

The easiest thing is to simply maintain your template repository inside your base16-build working folder (or symlink it).

You could facilitate this easily (from inside your template dir) with a tiny build script, etc:

#!/bin/bash
cd ../../..
base16 build

Credit where it's due

Color wheel icon thanks to Color icons created by Nikita Golubev - Flaticon.