Repository files navigation

A builder forbase16 andbase24 templates using the0.11.1builderspecification.

This repo contains a command-line tool,tinted-builder-rust, to buildbase16 and base24 templates. It is also contains a library crate,tinted-builder, which you can use to directly build templates withinyour own Rust application.

• CLI
  • Installation
  • Basic usage
  • Commands
  • Flags
• Builder specification
• Library
  • Library installation
  • Library usage
• Contributing
• License

Cargo

cargo install tinted-builder-rust

Homebrew

brew tap tinted-theming/tintedbrew install tinted-builder-rust

Binaries

Download the relevant binary from therepository releases page.

tinted-builder-rust sync# To sync with latest schemestinted-builder-rust build path/to/base16-template

The following is a table of the available subcommands for the CLI tool (tinted-builder-rust), including the descriptions and any notable arguments.

tinted-builder-rust implements the0.11.1builder specification. Thisspecification details the scheme yaml format or schema as well as thevariables the builder should provide when rendering template mustachefile. Have a look at thebuilder specification document for moredetails.

This library exposes aScheme andTemplate struct which you canuse to generate your own themes usingbase16 andbase24 templates and0.11.1 compliant base16 and base24 scheme files.

Internally tinted-builder-rust usesribboncurls to render the templates.

cargo add tinted-builder-rust

use tinted_builder_rust::{Scheme,Template};use std::fs::read_to_string;let template_str =read_to_string("path/to/template.mustache").unwrap();let scheme_str =read_to_string("path/to/scheme.yml").unwrap();let scheme =Scheme::Base16(serde_yaml::from_str(&scheme_str).unwrap());let template =Template::new(template_str, scheme);template.render().unwrap();

The Scheme struct is as follows:

use std::collections::HashMap;use tinted_builder::{SchemeSystem,SchemeVariant};pubstructScheme{pubsystem:SchemeSystem,pubname:String,pubslug:String,pubauthor:String,pubdescription:Option<String>,pubvariant:SchemeVariant,pubpalette:HashMap<String,Color>,}pubstructColor{pubhex:(String,String,String),pubrgb:(u8,u8,u8),pubdec:(f32,f32,f32),}

Template::newTheTemplate struct simply sets the content provided to it viaTemplate::new.

template.render_to_file(&scheme) takes the scheme and generates thevariables defined in the0.11.1builder specification.

Contributions are welcome! Have a look atCONTRIBUTING.md for moreinformation.

Ribboncurls is dual-licensed under the [Apache 2.0] and [MIT] licenses.For more information about the licenses of the projects used byRibboncurls, have a look atLICENSES-THIRD-PARTY.md.