Giter Club home page Giter Club logo

enlighten's Introduction

Enlighten - A Lighter Theme

Currently a work in progress.

Finished:

In Progress:

  • A color scheme with multiple language & highlight group support - enlighten.vim
  • Accessibility for users across all color scheme implementations.

enlighten.terminal ๐Ÿ‘ฉโ€๐ŸŽจ

Download enlighten.terminal and open it with Terminal.app to auto import.

curl -fLo ~/Downloads/enlighten.terminal \
  https://raw.githubusercontent.com/her/enlighten/master/enlighten.terminal

But Why?

Research has shown that text is easier to read on a light background. Users make less mistakes and it's easier on the eyes. However, most themes for both terminal emulators and text editors across the internet cater towards light text on a dark background.

The goal of this project is to develop the world's most beautiful and legible light theme for every day use. It should be accessible to everyone, adaptable to the user, and available on as many platforms as possible. Color choices should be based on a model of readability, easy discernment, and wherever possible should use color theory and science to lead development decisions.

This project is in it's early stages and I wouldn't say that it currently lives up to the stated goals. Going forward changes and developments should seek to uphold the ideals of this project by following it's goals.

Accessibility

Regular Bright
#000000 Black #666666 Bright Black
#B83520 Red #D84D62 Bright Red
#268800 Green #5EB055 Bright Green
#C1512C Yellow #DFC240 Bright Yellow
#2C69EE Blue #4D7DEA Bright Blue
#722ECF Magenta #C990F8 Bright Magenta
#408065 Cyan #55B0B2 Bright Cyan
#A3AFB6 White #FEFBED Bright White

Minimum contrast ratio requirements for AA grade
Normal text - 4.5:1
Large text - 3:1

Minimum contrast ratio requirements for AAA grade
Normal text - 7:1
Large text - 4.5:1

โœ… - Pass
โŒ - Fail

Passing requirements for color and brightness:
Color Difference - Minimum 500
Brightness Difference - Minimum 125

๐Ÿ‘ - Pass
โš ๏ธ - Fail

Compared against a background color of #FFFFFF

Examle of accessible color meansurement values:

Grade Contrast Ratio Color Difference Brightness Difference
AAA 21:1 765 255

As a list:
AAA, 21:1, 765, 255

#000000 Black #000000 โœ… ๐Ÿ‘
AAA, 21:1, 765, 255

#C30600 Red #C30600 โœ… ๐Ÿ‘
AA, 6.3:1, 564, 194

#007E00 Green #007E00 โœ… ๐Ÿ‘
AA, 5.3:1, 639, 182

#CD7F40 Yellow #CD7F40 โŒ โš ๏ธ
Fail, 3.1:1, 369, 112

#006A9D Blue '#006A9D' โœ… ๐Ÿ‘
AA, 5.9:1, 502, 175

#3C2DA2 Magenta #3C2DA2 โœ… โš ๏ธ
AAA, 10.1:1, 498, 193

#306B6A Cyan #306B6A โœ… ๐Ÿ‘
AA, 6.1:1, 504, 166

#A3AFB6 White #A3AFB6 โŒ โš ๏ธ
Fail, 2.2:1, 245, 83

#666666 Bright Black #666666 โœ… โš ๏ธ
AA, 5.7:1, 459, 153

#EC0000 Bright Red #EC0000 โœ… ๐Ÿ‘
AA, 4.6:1, 529, 185

#008500 Bright Green #008500 โœ… ๐Ÿ‘
AA, 4.8:1, 632, 177

#E9AD53 Bright Yellow #E9AD53 โŒ โš ๏ธ
Fail, 2:1, 276, 75

#1761BE Bright Blue #1761BE โœ… โš ๏ธ
AA, 6:1, 455, 170

#B20F4A Bright Magenta #B20F4A โœ… โš ๏ธ
AA, 6.9:1, 498, 185

#276F6F Bright Cyan #276F6F โœ… ๐Ÿ‘
AA, 5.9:1, 504, 166

#FFFFFF Bright White #FFFFFF โŒ โš ๏ธ
Fail, 1:1, 0, 0

Notes on Grading

AAA grade is given for passing all the above requirements.
AA grade will be given for passing Normal Text requirements.

โš ๏ธ Careful consideration before use. Against another listed color this may be fine to use, but you should take into account the user.

Included Highlight Groups

Ruby, Python, Javascript, JSON, SQL, YAML, XML, HTML, CSS, Markdown, Shell, Vim's defaults (Language Constructs, Variable Types, C Family), netrw.

Will add other highlight groups once the above are completed. Possibly next being, Perl, php. Also am considering other add-on syntax groups like NGINX or Docker (which would require extending vim with a syntax library for these technologies).

Notes

Valuable Vim Docs

:h group-name :h highlight-groups :h cterm-colors

If editing a colorscheme this applies it to the current buffer

:w :so %

Output all the current highlight groups

:so $VIMRUNTIME/syntax/hitest.vim

Colour Contrast Analyser

Color Oracle

Color Usage Research Lab

https://colorusage.arc.nasa.gov/GuidelinesHierarchy.php

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.