<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>README.md - fork/helix @ 24.07</title>
<meta name="description" content="README.md in fork/helix at 24.07.">
<meta property="og:title" content="README.md - fork/helix @ 24.07">
<meta property="og:description" content="README.md in fork/helix at 24.07.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="24.07" data-tip="079f544260f4f5eaff08104bf07abd57bfb7b611">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/helix</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/helix</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Masanori Ogino</span><span class="commit-message" data-commit="c9b484097b045a34b709131fc62e87ba21789d1a">Exclude EOL repos from the Repology badge (#11159)</span><span class="snapshot-sha sha" data-commit="c9b484097b045a34b709131fc62e87ba21789d1a">c9b48409</span><time datetime="2024-07-14T11:31:33+09:00" title="2024-07-14 11:31:33 +0900">2024-07-14</time></p>
<header class="topbar"><details class="switcher"><summary>24.07</summary><div class="menu"><strong>branches</strong><a href="/fork/helix/ref/master/">master</a><strong>tags</strong><a href="/fork/helix/ref/23.05/">23.05</a><a href="/fork/helix/ref/23.10/">23.10</a><a href="/fork/helix/ref/24.03/">24.03</a><a class="current" href="/fork/helix/ref/24.07/">24.07</a><a href="/fork/helix/ref/25.01/">25.01</a><a href="/fork/helix/ref/25.01.1/">25.01.1</a><a href="/fork/helix/ref/25.07/">25.07</a><a href="/fork/helix/ref/25.07.1/">25.07.1</a><a class="all" href="/fork/helix/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/helix/">helix</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>2.6 KiB</span><span>64 lines</span></span><span class="actions"><a class="raw" href="/fork/helix/raw/3b639214d8b64c46e51a871104c0cab77c7d49da/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;div align="center"&gt;
&lt;h1&gt;
&lt;picture&gt;
  &lt;source media="(prefers-color-scheme: dark)" srcset="logo_dark.svg"&gt;
  &lt;source media="(prefers-color-scheme: light)" srcset="logo_light.svg"&gt;
  &lt;img alt="Helix" height="128" src="logo_light.svg"&gt;
&lt;/picture&gt;
&lt;/h1&gt;
<p><a href="https://github.com/helix-editor/helix/actions"><img src="https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg" alt="Build status" /></a>
<a href="https://github.com/helix-editor/helix/releases/latest"><img src="https://img.shields.io/github/v/release/helix-editor/helix" alt="GitHub Release" /></a>
<a href="https://docs.helix-editor.com/"><img src="https://shields.io/badge/-documentation-452859" alt="Documentation" /></a>
<a href="https://github.com/helix-editor/helix/graphs/contributors"><img src="https://img.shields.io/github/contributors/helix-editor/helix" alt="GitHub contributors" /></a>
<a href="https://matrix.to/#/#helix-community:matrix.org"><img src="https://img.shields.io/matrix/helix-community:matrix.org" alt="Matrix Space" /></a></p>
&lt;/div&gt;
<p><img src="/fork/helix/raw/5fb72dcc5cea7ede7fb0f323e833d090088e6f38/screenshot.png" alt="Screenshot" /></p>
<p>A <a href="https://github.com/mawww/kakoune">Kakoune</a> / <a href="https://github.com/neovim/neovim">Neovim</a> inspired editor, written in Rust.</p>
<p>The editing model is very heavily based on Kakoune; during development I found
myself agreeing with most of Kakoune's design decisions.</p>
<p>For more information, see the <a href="https://helix-editor.com">website</a> or
<a href="https://docs.helix-editor.com/">documentation</a>.</p>
<p>All shortcuts/keymaps can be found <a href="https://docs.helix-editor.com/keymap.html">in the documentation on the website</a>.</p>
<p><a href="https://github.com/helix-editor/helix/wiki/Troubleshooting">Troubleshooting</a></p>
<h1>Features</h1>
<ul>
<li>Vim-like modal editing</li>
<li>Multiple selections</li>
<li>Built-in language server support</li>
<li>Smart, incremental syntax highlighting and code editing via tree-sitter</li>
</ul>
<p>It's a terminal-based editor first, but I'd like to explore a custom renderer
(similar to Emacs) in wgpu or skulpin.</p>
<p>Note: Only certain languages have indentation definitions at the moment. Check
<code>runtime/queries/&lt;lang&gt;/</code> for <code>indents.scm</code>.</p>
<h1>Installation</h1>
<p><a href="https://docs.helix-editor.com/install.html">Installation documentation</a>.</p>
<p><a href="https://repology.org/project/helix/versions"><img src="https://repology.org/badge/vertical-allrepos/helix.svg?exclude_unsupported=1" alt="Packaging status" /></a></p>
<h1>Contributing</h1>
<p>Contributing guidelines can be found <a href="/fork/helix/ref/24.07/blob/docs/CONTRIBUTING.md">here</a>.</p>
<h1>Getting help</h1>
<p>Your question might already be answered on the <a href="https://github.com/helix-editor/helix/wiki/FAQ">FAQ</a>.</p>
<p>Discuss the project on the community <a href="https://matrix.to/#/#helix-community:matrix.org">Matrix Space</a> (make sure to join <code>#helix-editor:matrix.org</code> if you're on a client that doesn't support Matrix Spaces yet).</p>
<h1>Credits</h1>
<p>Thanks to <a href="https://github.com/jakenvac">@jakenvac</a> for designing the logo!</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>&lt;</a-p><a-tg>div</a-tg> <a-at>align</a-at>=&quot;<a-s>center</a-s>&quot;<a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>&lt;</a-p><a-tg>h1</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>&lt;</a-p><a-tg>picture</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>source</a-tg><a-p> </a-p><a-at>media</a-at><a-p>=&quot;</a-p><a-s>(prefers-color-scheme: dark)</a-s><a-p>&quot; </a-p><a-at>srcset</a-at><a-p>=&quot;</a-p><a-s>logo_dark.svg</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>source</a-tg><a-p> </a-p><a-at>media</a-at><a-p>=&quot;</a-p><a-s>(prefers-color-scheme: light)</a-s><a-p>&quot; </a-p><a-at>srcset</a-at><a-p>=&quot;</a-p><a-s>logo_light.svg</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>  &lt;</a-p><a-tg>img</a-tg><a-p> </a-p><a-at>alt</a-at><a-p>=&quot;</a-p><a-s>Helix</a-s><a-p>&quot; </a-p><a-at>height</a-at><a-p>=&quot;</a-p><a-s>128</a-s><a-p>&quot; </a-p><a-at>src</a-at><a-p>=&quot;</a-p><a-s>logo_light.svg</a-s><a-p>&quot;&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>picture</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>h1</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>[![GitHub Release](https://img.shields.io/github/v/release/helix-editor/helix)](https://github.com/helix-editor/helix/releases/latest)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>[![Documentation](https://shields.io/badge/-documentation-452859)](https://docs.helix-editor.com/)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>[![GitHub contributors](https://img.shields.io/github/contributors/helix-editor/helix)](https://github.com/helix-editor/helix/graphs/contributors)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>[![Matrix Space](https://img.shields.io/matrix/helix-community:matrix.org)](https://matrix.to/#/#helix-community:matrix.org)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>&lt;/div&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>![Screenshot](./screenshot.png)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>A [Kakoune](https://github.com/mawww/kakoune) / [Neovim](https://github.com/neovim/neovim) inspired editor, written in Rust.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>The editing model is very heavily based on Kakoune; during development I found</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>myself agreeing with most of Kakoune&#39;s design decisions.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>For more information, see the [website](https://helix-editor.com) or</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>[documentation](https://docs.helix-editor.com/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>[Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p># </a-p><a-tt>Features</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>- Vim-like modal editing</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>- Multiple selections</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>- Built-in language server support</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>- Smart, incremental syntax highlighting and code editing via tree-sitter</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>It&#39;s a terminal-based editor first, but I&#39;d like to explore a custom renderer</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>(similar to Emacs) in wgpu or skulpin.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>Note: Only certain languages have indentation definitions at the moment. Check</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>`runtime/queries/&lt;lang&gt;/` for `indents.scm`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p># </a-p><a-tt>Installation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>[Installation documentation](https://docs.helix-editor.com/install.html).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg?exclude_unsupported=1)](https://repology.org/project/helix/versions)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p># </a-p><a-tt>Contributing</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p># </a-p><a-tt>Getting help</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>Discuss the project on the community [Matrix Space](https://matrix.to/#/#helix-community:matrix.org) (make sure to join `#helix-editor:matrix.org` if you&#39;re on a client that doesn&#39;t support Matrix Spaces yet).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p># </a-p><a-tt>Credits</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text">Thanks to [@jakenvac](https://github.com/jakenvac) for designing the logo!</span></span></pre></div></div>
</main>
</body>
</html>
