runtime/help/help.md

   1 # Micro help text
   2
   3 Micro is a terminal-based text editor that aims to be easy to use and intuitive,
   4 while also taking advantage of the full capabilities of modern terminals.
   5
   6 *Press CtrlQ to quit, and CtrlS to save.*
   7
   8 If you want to see all the keybindings press CtrlE and type `help keybindings`.
   9
  10 See the next section for more information about documentation and help.
  11
  12 ### Accessing more help
  13
  14 Micro has a built-in help system much like Vim's (although less extensive).
  15
  16 To use it, press CtrlE to access command mode and type in `help` followed by a topic.
  17 Typing `help` followed by nothing will open this page.
  18
  19 Here are the possible help topics that you can read:
  20
  21 * tutorial: A brief tutorial which gives an overview of all the other help topics
  22 * keybindings: Gives a full list of the default keybindings as well as how to rebind them
  23 * commands: Gives a list of all the commands and what they do
  24 * options: Gives a list of all the options you can customize
  25 * plugins: Explains how micro's plugin system works and how to create your own plugins
  26 * colors: Explains micro's colorscheme and syntax highlighting engine and how to create your
  27   own colorschemes or add new languages to the engine
  28
  29 For example, to open the help page on plugins you would press CtrlE and type `help plugins`.
  30
  31 I recommend looking at the `tutorial` help file because it is short for each section and
  32 gives concrete examples of how to use the various configuration options in micro. However,
  33 it does not give the in-depth documentation that the other topics provide.