basis/editors/kakoune/kakoune-docs.factor

   1 ! Copyright (C) 2022 Raghu Ranganathan.
   2 ! See https://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax editors ;
   4 IN: editors.kakoune
   5
   6 HELP: actual-kak-path
   7 { $values
   8     { "path" "a pathname string" }
   9 }
  10 { $description "Pushes the path to kakoune recognized by factor." } ;
  11
  12 HELP: find-kak-path
  13 { $values
  14     { "path" "a pathname string" }
  15 }
  16 { $description "A word which finds kakoune in your unix system's PATH variable." } ;
  17
  18 HELP: kak-path
  19 { $var-description "Set this variable to a sequence of strings that indicate the command to be run when factor wants to invoke kakoune. For example, on the author's system, this is " { $snippet "{ \"alacritty\" \"-e\" \"kak\" }" } } ;
  20
  21 HELP: kakoune
  22 { $class-description "The editor class for kakoune. To switch to kakoune as your primary editor, you can set " { $link editor-class } " to this singleton class." } ;
  23
  24 ARTICLE: "editors.kakoune" "Kakoune support"
  25 "The " { $link kak-path } " variable contains the name of the kak executable. The default " { $link kak-path } " is " { $snippet "\"kak\"" } ". Which is not very useful, as it starts kakoune in the same terminal where you started factor."
  26 $nl
  27 "You can install an editor plugin for kakoune at " { $url "https://github.com/razetime/kakoune-factor" }
  28 ;
  29
  30 ABOUT: "editors.kakoune"