bendns' repos / helix
Unnamed repository; edit this file 'description' to name the repository. 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

# Sunset
# Author : Egor Afanasin <[email protected]>
# Repo: https://github.com/pithecantrope/sunset

# Syntax highlighting
# ----------------------------------------------------------------
attribute = "rose"

type = "rose"
"type.builtin" = { fg = "rose", modifiers = ["italic"] }

constructor = "wood"

constant = "fire"
"constant.builtin"   = { fg = "fire", modifiers = ["italic"] }
"constant.character" = "wood"
"constant.character.escape" = "pink"
"constant.numeric"   = "wood"

string = "grass"
"string.regexp"  = "pink"
"string.special" = "rose"
"string.special.symbol" = "fire"

comment = { fg = "cmnt", modifiers = ["italic"] }
"comment.block.documentation" = "grass"

variable = "text"
"variable.builtin" = { fg = "sky", modifiers = ["italic"] }
# TODO: variable.parameter
"variable.other.member" = "mud"

label = "sky"

punctuation = "cmnt"
"punctuation.special" = "wine"

keyword = "sun"
"keyword.control.return"    = { fg = "sun", modifiers = ["italic"] }
"keyword.control.exception" = { fg = "sun", modifiers = ["italic"] }
"keyword.directive" = "sky"

operator = "wine"

function = "peach"
"function.builtin" = { fg = "peach", modifiers = ["italic"] }
"function.macro"   = "pink"

tag = "peach"

namespace = { fg = "pink", modifiers = ["italic"] }

special = "sky"

# Editor interface
# ----------------------------------------------------------------
"markup.heading.marker" = "sun"
"markup.heading.1" = "attn"
"markup.heading.2" = "fire"
"markup.heading.3" = "rose"
"markup.heading.4" = "peach"
"markup.heading.5" = "wine"
"markup.heading.6" = "grass"

"markup.list" = "wood"

"markup.bold"          = { modifiers = ["bold"] }
"markup.italic"        = { modifiers = ["italic"] }
"markup.strikethrough" = { modifiers = ["crossed_out"] }

"markup.link.url"   = { fg = "sky", underline.style = "line" }
"markup.link.label" = { fg = "sky", modifiers = ["italic"] }
"markup.link.text"  = "mud"

"markup.quote" = "grass"

"markup.raw"   = "pink"

"diff.plus"  = "grass"
"diff.minus" = "attn"
"diff.delta" = "sky"

# User interface
# ----------------------------------------------------------------
"ui.background" = { fg = "text", bg = "base" }

"ui.cursor" = { modifiers = ["reversed"] }
"ui.cursor.match" = { fg = "attn", modifiers = ["bold"] }

# TODO: ui.debug

"ui.linenr" = "block"
"ui.linenr.selected" = "cmnt"

"ui.statusline" = { bg = "block" }
"ui.statusline.inactive" = { fg = "cmnt" }
"ui.statusline.normal"   = { fg = "block", bg = "sun",  modifiers = ["bold"] }
"ui.statusline.insert"   = { fg = "block", bg = "grass", modifiers = ["bold"] }
"ui.statusline.select"   = { fg = "block", bg = "wine",  modifiers = ["bold"] }

"ui.bufferline" = { fg = "cmnt", bg = "block" }
"ui.bufferline.active" = "sun"

"ui.popup" = { fg = "text", bg = "base" }
"ui.popup.info" = { fg = "text", bg = "block" }

"ui.window" = { fg = "block", modifiers = ["bold"] }

"ui.help" = { fg = "text", bg = "block" }

"ui.text" = { fg = "text", bg = "base" }
"ui.text.directory" = "sky"
"ui.text.focus"     = "sun"
"ui.text.inactive"  = { fg = "cmnt", modifiers = ["italic"] }
"ui.text.info"      = { bg = "block" }

"ui.virtual" = { fg = "block" }
"ui.virtual.ruler"        = { bg = "block" }
"ui.virtual.indent-guide" = "sel"
"ui.virtual.jump-label"   = { fg = "attn", modifiers = ["bold"] }

"ui.menu" = { fg = "text", bg = "base" }
"ui.menu.selected" = { bg = "sel" }
"ui.menu.scroll"   = "sel"

"ui.selection" = { bg = "sel" }

"ui.highlight" = { bg = "sel" }

error   = "attn"
warning = "fire"
info    = "pink"
hint    = "sky"

diagnostic = { underline.style = "line" }

[palette]
# Reddish
fire  = "#EE7711"
rose  = "#EE7777"
peach = "#EEBB77"
pink  = "#EEAAAA"
wood  = "#997755"

# Greenish
grass = "#66CC33"
mud   = "#BBCC77"
sun   = "#EEEE11"

# Bluish
sky  = "#77AAAA"
wine = "#775599"

# Ui
base  = "#111111"
block = "#222222"
sel   = "#333333"
cmnt  = "#777777"
text  = "#EEEEEE"
attn  = "#EE1111"
cs.helix-editor.com/keymap.html">in the documentation on the website.

Troubleshooting

Features

It's a terminal-based editor first, but I'd like to explore a custom renderer (similar to emacs) in wgpu or skulpin.

Note: Only certain languages have indentation definitions at the moment. Check runtime/queries/<lang>/ for indents.toml.

Installation

Packages are available for various distributions (see Installation docs).

If you would like to build from source:

git clone https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term
hx --grammar fetch
hx --grammar build

This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars.

Helix also needs its runtime files so make sure to copy/symlink the runtime/ directory into the config directory (for example ~/.config/helix/runtime on Linux/macOS, or %AppData%/helix/runtime on Windows).

OS command
windows xcopy runtime %AppData%/helix/runtime
linux/macos ln -s $PWD/runtime ~/.config/helix/runtime

This location can be overridden via the HELIX_RUNTIME environment variable.

Packages already solve this for you by wrapping the hx binary with a wrapper that sets the variable to the install dir.

NOTE: running via cargo also doesn't require setting explicit HELIX_RUNTIME path, it will automatically detect the runtime directory in the project root.

In order to use LSP features like auto-complete, you will need to install the appropriate Language Server for a language.

Packaging status

MacOS

Helix can be installed on MacOS through homebrew via:

brew tap helix-editor/helix
brew install helix

Contributing

Contributing guidelines can be found here.

Getting help

Your question might already be answered on the FAQ.

Discuss the project on the community Matrix Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).