search

helix-editor / helix

A post-modern modal text editor.
https://helix-editor.com
Mozilla Public License 2.0
34.03k stars 2.52k forks source link

Book shows features before they're released #1607

Closed Aloso closed 2 years ago

Aloso commented 2 years ago

Go to https://docs.helix-editor.com/configuration.html. It includes the following example config:

  theme = "onedark"

  [editor]
  line-number = "relative"
  mouse = false

  [editor.cursor-shape]
  insert = "bar"
  normal = "block"
  select = "underline"

  [editor.file-picker]
  hidden = false

However, if you copy+paste this into ~/.config/helix/config.toml, helix shows this error on startup:

Bad config: unknown field `cursor-shape`, expected one of `scrolloff`, `scroll-lines`, `mouse`, `shell`, `line-number`, `middle-click-paste`, `smart-case`, `auto-pairs`, `auto-completion`, `idle-timeout`, `completion-trigger-len`, `auto-info`, `file-picker`, `true-color` for key `editor` at line 7 column 1
Press <ENTER> to continue with default config

The reason is that the cursor-shape config option was introduced after the latest version, helix v0.6.0. The book published at https://docs.helix-editor.com should reflect the state of the current version, not of the master branch.

archseer commented 2 years ago

Yeah it builds against latest master instead of the release. I could use some help with the Github Actions set up so we'd have two different builds for stable & master.