Skip to content

Latest commit

 

History

History
94 lines (72 loc) · 2.37 KB

airline.md

File metadata and controls

94 lines (72 loc) · 2.37 KB
Raw

Airline themes

Creating styles

Before creating the airline theme you need at least one color palette in estilos/palettes directory. Then create your airline style as a .yml file inside estilos/airline folder, and paste this content:

normal1: ''
normal2: ''
normal3: ''
inactive1: ''
inactive2: ''
inactive3: ''
insert1: ''
insert2: ''
insert3: ''
replace1: ''
replace2: ''
replace3: ''
visual1: ''
visual2: ''
visual3: ''
ctrlp1: '' # optional
ctrlp2: '' # optional
ctrlp3: '' # optional

Every property in the template is composed by a name and a number, they represents how a part of the status line will look in a particular vim mode. That means the first line defines the style of the part 1 of the bar in normal mode, and so on.

Part 1 represents the first and the last block of the status bar, part 2 the second and fourth, and the part 3 is for the center block (the third one).

airline blocks

Go to the first definition and fill its value inside the quotes (''), write the foreground and the background color names separated by a space (these ones should be in your color template). It should look something like this:

normal1: 'myblue mydark'

Add theme to estilo.yml

Open estilo.yml file and add an object for each theme with its parameters inside airline list. Every one has 3 parameters:

  • name: the name of the airline theme (should have not spaces)
  • palette: the name of the color palette. It's the same as the file inside palettes folder without the .yml extension
  • style: It's the same as the file inside airline folder without the .yml extension

Example:

airline:
  - name: 'awesome-night'
    palette: 'awesome'
    style: 'night'
  - name: 'awesome-day'
    palette: 'awesome'
    style: 'day'

Render

With the command line in the project folder:

estilo render

Rendered files are in plugins folder of your project

Activating the theme

Open your vim config file and add the next lines:

let g:PKG_NAME_airline = 1
let g:airline_theme = 'MY_THEME_NAME'

Replace PKG_NAME with the name of your project (the name from estilo.yml), and MY_THEME_NAME with the name of the Airline theme you want to activate.

Remember to add instructions to the README of your project before you publish it.