tinted-theming / base24

Base24/ Base16 can be used to easily generate your favourite theme for your favourite application. Many of the template repositories provide theme files that you can copy/ import into said application.
MIT License
68 stars 7 forks source link
base24 base24-builder base24-scheme base24-template base24-theme theme theming

Tinted Theming: all your themes, everywhere.

Color wheel

Style systems and smart build tooling for crafting high fidelity color schemes and easily using them in all your favorite apps. Originally based on the amazing work of Chris Kempson and his Base16 system.

Features

Base24 Compatibility

The aim of this project is to offer compatibility with base16. The only limitation is that a base24 builder is needed for base24 templates.

Theme Template Base16 Builder Base24 Builder
Base16 Base16 :heavy_check_mark: :heavy_check_mark:
Base24 Base16 :heavy_check_mark: :heavy_check_mark:
Base16 Base24 :x: :heavy_check_mark:
Base24 Base24 :x: :heavy_check_mark:

Documentation and Specification

The builder and styling specs detail how to compile schemes and templates into application specific configurations.

Scheme

A scheme is a fixed palette of named colors and (optionally) instructions for how those colors should be used by apps.

Style

A style guide provides rules governing how a scheme's palette should be applied within apps. This means each color is used consistently for similar purposes across all your apps. Individual styling guides often support different sized pallets and have different ideas about how those colors should be deployed.

See the individual styling guides for more information on each:

A scheme is defined using a YAML file. The file specification is in the Builder Guidelines.

Builder

A builder is a build tool used by various template repositories to generate files based on scheme file and template file.

Template

A template describes how a scheme should be transformed to support a specific application. A template repository defines a template file, then uses a builder to generate application specific files using the template.

Templates often include ready-to-use pre-built versions of every scheme. These are typically installed directly by end users to use the schemes in different applications.

Supported Applications (Base24)

To add your own template, submit a pull request to URL and add your repository to the list below. Repository naming scheme: base24-[template-name] (with dashes as separators).

Existing Base16 Templates (Base16)

Scheme Repositories

To add your own scheme, submit a pull request to URL and add your repository to the list below. Repository naming scheme: base24-[scheme-name]-scheme (with dashes as separators).

Generated from existing themes

Existing Base16 Schemes

Builder Repositories

Repository naming scheme: base24-builder-[language] (with dashes as separators). The separate headings are the latest versions of the spec supported by each builder.

Download

Clone

Using The Command Line

  1. Press the Clone or download button in the top right
  2. Copy the URL (link)
  3. Open the command line and change directory to where you wish to clone to
  4. Type 'git clone' followed by URL in step 2
git clone https://github.com/tinted-theming/Base24

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

  1. Press the Clone or download button in the top right
  2. Click open in desktop
  3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

  1. Download this GitHub repository
  2. Extract the zip archive
  3. Copy/ move to the desired location

Community

Licence

MIT License (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Project Chat

Have something you want to discuss, but you're not sure it warrants an issue? Feel free to stop by the #base16 channel on Libera Chat or the bridged Matrix channel to talk about it.

Credits