Skip to content

heygsiri/base16

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Base16

An architecture for building themes based on carefully chosen syntax highlighting using a base of sixteen colors. Base16 provides a set of guidelines detailing how to style syntax and how to code a builder for compiling Base16 schemes and templates.

Documentation

Template Repositories

To add your own template, submit a pull request to https://github.com/chriskempson/base16-templates-source and add your repository to the list below. Repository naming scheme: base16-[template-name] (with dashes as separators).

Official Templates

As a part of the Base16 Project, we maintain a number of templates. Each has been sponsored by at least one base16 project member who is committed to maintaining that template.

We are open to accepting new projects, though they must still be sponsored by a base16 project member and have some level of activity.

Contrib Templates

In order to prevent ownership issues, we're introducing the concept of contrib templates. These are templates which have been handed over to the base16-project, but either aren't sponsored by a base16-project member or don't have enough usage to warrent including with our official templates.

Submitting a repository to base16-project-contrib and continuing to work on it is a great way to get involved and get noticed as a maintainer so you can work towards getting added to the base16-project team.

Unofficial Templates

If you have a template you maintain, but don't want to submit it to the contrib repositories, feel free to add a link to the repository here to add it to this list. These are community maintained templates and may not be updated often.

Schemes

To add your own scheme, submit a pull request to the base16-schemes repo and add your scheme.

Builders

Normally end-users should not need to use builders, as they're primarily meant for maintainers - both scheme and template maintainers. These are tools used to build templates with all the currently submitted schemes.

Official Builder Repositories

Similar to our split between official and unofficial templates, we also have a similar split for builders. Spec changes will not be merged until there is consensus among maintainers and at least one builder with a pull request ready for implementing that spec version.

Unofficial Builder Repositories

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

Changelog

0.10.0 (Mar 20, 2021)

  • Simplify repo structure and builder responsibilities
  • Clarify that using a hash as a part of the color is allowed

0.9.1 (Jun 15, 2019)

  • Make baseXX-hex-bgr variables available to templates
  • Warn when a template file has been overwritten

0.9.0 (Jul 6, 2017)

  • Add decimal color variables

0.8.1 (Dec 29, 2016)

  • Clarify theme filename generation
  • Various clarifications

0.8.0 (Aug 27, 2016)

  • Drop support for HSL variables

Scheme and Template Author Resources

The following is a list of useful resources for anyone creating a Base16 scheme and or template:

  • Code Examples - A list of example code file for various languages.
  • TmTheme Editor - An online editor for themes in tmTheme format.
  • Base16 Template Converter - A script to automatically convert Base16 templates written in the old Embedded Ruby style to the new Mustache style.

Tools for using Base16

If you've written a tool for base16 feel free to add it to the list below:

  • auto-base16-theme - A command line tool to create a base16 theme from an input image's color palette.
  • base16-manager - A command line tool to install base16 templates and set themes globally.
  • base16-shell-preview - A command line tool to preview and set base16-shell themes.
  • base16-universal-manager - A command line tool to automatically get, build and set base16 themes globally for all supported applications. Themes and templates are pulled form the official repositories or from a local cache.
  • flavours - A command line tool to manage and globally apply base16 templates by specifying a scheme name.
  • Themix/Oomox - Graphical application for generating different color variations of a Arc, Materia and Oomox themes (GTK2, GTK3 and others), Archdroid, Gnome-Colors and Numix icons, and terminal palette. Base16 plugin allows to open Base16 YAML files a export both Base16 and its own themes using Base16 Mustache templates.
  • base16-spectrum-generator - A Python script for generating .png files showcasing the colours in a base16 theme.

Projects using Base16

About

An architecture for building themes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published