Skip to content

Commit

Permalink
Link to repository for Zed editor support
Browse files Browse the repository at this point in the history
  • Loading branch information
mlochbaum committed Jun 22, 2024
1 parent 891b1e9 commit 9bd1500
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/editors/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ <h3 id="kakoune"><a class="header" href="#kakoune">Kakoune</a></h3>
<p>Copy or symlink <code><span class='Value'>kak</span><span class='Function'>/</span><span class='Value'>autoload</span><span class='Function'>/</span><span class='Value'>filetype</span><span class='Function'>/</span><span class='Value'>bqn.kak</span></code> into <code><span class='Value'>autoload</span><span class='Function'>/</span><span class='Value'>filetype</span></code> in your Kakoune config directory (probably <code><span class='Value'>.config</span><span class='Function'>/</span><span class='Value'>kak</span><span class='Function'>/</span></code>).</p>
<h3 id="micro"><a class="header" href="#micro">Micro</a></h3>
<p>See <a href="https://github.com/0racle/micro-bqn">micro-bqn</a>.</p>
<h3 id="zed"><a class="header" href="#zed">Zed</a></h3>
<p>See <a href="https://github.com/DavidZwitser/zed-bqn">zed-bqn</a>.</p>
<h2 id="alternate-layouts"><a class="header" href="#alternate-layouts">Alternate layouts</a></h2>
<p>All files here use the BQN layout designed for qwerty, which will generally be jumbled in another layout (for example the key for <code><span class='Value'>r</span></code> will still type <code><span class='Function'></span></code>, but it may not be above <code><span class='Value'>c</span></code>, which types <code><span class='Function'></span></code>). The <a href="https://github.com/mlochbaum/BQN/blob/master/editors/remap.bqn">remap.bqn</a> script allows you to remap some files in this repository to a new layout. See <code><span class='Value'>$</span> <span class='Value'>.</span><span class='Function'>/</span><span class='Value'>remap.bqn</span> <span class='Function'>-</span><span class='Value'>h</span></code> for usage. Support for a new layout can be added in the <code><span class='Value'>keys</span></code> array of the script, but do watch for string alignment with the doubled quote character.</p>
<p>(If you haven't installed CBQN but have Node.js, <code><span class='Value'>$</span> <span class='Value'>bqn.js</span> <span class='Value'>editors</span><span class='Function'>/</span><span class='Value'>remap.bqn…</span></code> from the repository root will work too)</p>
4 changes: 4 additions & 0 deletions editors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ Copy or symlink `kak/autoload/filetype/bqn.kak` into `autoload/filetype` in your

See [micro-bqn](https://github.com/0racle/micro-bqn).

### Zed

See [zed-bqn](https://github.com/DavidZwitser/zed-bqn).

## Alternate layouts

All files here use the BQN layout designed for qwerty, which will generally be jumbled in another layout (for example the key for `r` will still type ``, but it may not be above `c`, which types ``). The [remap.bqn](remap.bqn) script allows you to remap some files in this repository to a new layout. See `$ ./remap.bqn -h` for usage. Support for a new layout can be added in the `keys` array of the script, but do watch for string alignment with the doubled quote character.
Expand Down

0 comments on commit 9bd1500

Please sign in to comment.