Hopiu/micro
1
0
Fork 0
mirror of https://github.com/Hopiu/micro.git synced 2026-03-17 06:20:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
micro/runtime/help/help.md

61 lines
2.5 KiB
Markdown
Raw Normal View History

Improve help text and move to its own file
2016-04-24 12:31:42 +00:00
# Micro help text
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
Micro is an easy to use, intuitive, text editor that takes advantage of the
full capabilities of modern terminals.
Improve help text
2016-04-24 12:38:38 +00:00
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
Micro can be controlled by commands entered on the command bar, or with
help: Exchange all indentations to spaces, remove trailing ws and generalize indentations (#3193) * help: Exchange all indentations to spaces and remove trailing ws * Add some missing `` marks Co-authored-by: Jöran Karl <3951388+JoeKar@users.noreply.github.com> * help: Generalize indentation levels * help: Some small visual changes - removed some superfluous whitespaces - add a line break in before an link - corrected one typo --------- Co-authored-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
2024-03-22 16:58:44 +00:00
keybindings. To open the command bar, press `Ctrl-e`: the `>` prompt will
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
display. From now on, when the documentation shows a command to run (such as
help: Exchange all indentations to spaces, remove trailing ws and generalize indentations (#3193) * help: Exchange all indentations to spaces and remove trailing ws * Add some missing `` marks Co-authored-by: Jöran Karl <3951388+JoeKar@users.noreply.github.com> * help: Generalize indentation levels * help: Some small visual changes - removed some superfluous whitespaces - add a line break in before an link - corrected one typo --------- Co-authored-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
2024-03-22 16:58:44 +00:00
`> help`), press `Ctrl-e` and type the command followed by enter.
Update help to give quick instructions on quitting and saving
2016-08-31 01:29:41 +00:00
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
For a list of the default keybindings, run `> help defaultkeys`.
For more information on keybindings, see `> help keybindings`.
To toggle a short list of important keybindings, press Alt-g.
Add new shell command documentation Ref #979
2018-01-23 02:03:52 +00:00
Use more consisten syntax in md files, format tp 80 collumns, fix some typos
2017-10-11 13:16:53 +00:00
## Quick-start
help: Exchange all indentations to spaces, remove trailing ws and generalize indentations (#3193) * help: Exchange all indentations to spaces and remove trailing ws * Add some missing `` marks Co-authored-by: Jöran Karl <3951388+JoeKar@users.noreply.github.com> * help: Generalize indentation levels * help: Some small visual changes - removed some superfluous whitespaces - add a line break in before an link - corrected one typo --------- Co-authored-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
2024-03-22 16:58:44 +00:00
To quit, press `Ctrl-q`. Save by pressing `Ctrl-s`. Press `Ctrl-e`, as previously
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
mentioned, to start typing commands. To see which commands are available, at the
prompt, press tab, or view the help topic with `> help commands`.
Use more consisten syntax in md files, format tp 80 collumns, fix some typos
2017-10-11 13:16:53 +00:00
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
Move the cursor around with the mouse or with the arrow keys. Enter text simply
by pressing character keys.
Add quick start guide to help.md
2016-09-16 16:14:08 +00:00
Use more consisten syntax in md files, format tp 80 collumns, fix some typos
2017-10-11 13:16:53 +00:00
If the colorscheme doesn't look good, you can change it with
More plugin docs and improve doc formatting
2020-02-08 23:31:06 +00:00
`> set colorscheme ...`. You can press tab to see the available colorschemes,
or see more information about colorschemes and syntax highlighting with `> help
colors`.
Add quick start guide to help.md
2016-09-16 16:14:08 +00:00
help: Exchange all indentations to spaces, remove trailing ws and generalize indentations (#3193) * help: Exchange all indentations to spaces and remove trailing ws * Add some missing `` marks Co-authored-by: Jöran Karl <3951388+JoeKar@users.noreply.github.com> * help: Generalize indentation levels * help: Some small visual changes - removed some superfluous whitespaces - add a line break in before an link - corrected one typo --------- Co-authored-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
2024-03-22 16:58:44 +00:00
Press `Ctrl-w` to move between splits, and type `> vsplit filename` or
Use more consisten syntax in md files, format tp 80 collumns, fix some typos
2017-10-11 13:16:53 +00:00
`> hsplit filename` to open a new split.
Add quick start guide to help.md
2016-09-16 16:14:08 +00:00
Use more consisten syntax in md files, format tp 80 collumns, fix some typos
2017-10-11 13:16:53 +00:00
## Accessing more help
Split help into multiple files and add help command
2016-07-28 19:52:31 +00:00
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
Micro has a built-in help system which can be accessed with the `> help` command.
Split help into multiple files and add help command
2016-07-28 19:52:31 +00:00
help: Exchange all indentations to spaces, remove trailing ws and generalize indentations (#3193) * help: Exchange all indentations to spaces and remove trailing ws * Add some missing `` marks Co-authored-by: Jöran Karl <3951388+JoeKar@users.noreply.github.com> * help: Generalize indentation levels * help: Some small visual changes - removed some superfluous whitespaces - add a line break in before an link - corrected one typo --------- Co-authored-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
2024-03-22 16:58:44 +00:00
To view help for the various available topics, press `Ctrl-e` to access command
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
mode and type in `> help` followed by a topic. Typing just `> help` will open
this page.
Split help into multiple files and add help command
2016-07-28 19:52:31 +00:00
Doc changes (#2646) Try to make things a little more concise to start with, remove a couple of repetitions. This seems like a good editor for people starting out, and I like it as a good alternative to nano for explaining to beginners how to edit config files. If you appreciate the suggestions, I can go over the rest of the documentation, in the hope of making things even easier to get going with. If the line breaks are off, I can redo this in a text editor, rather than on the web on github. I've limited the changes, but I could make a few more changes to style... Btw, the tutorial is just about settings. I'm guessing this is just because things aren't finished, but I'm asking just in case this is an error and there may exist a tutorial somewhere.
2023-01-12 05:56:23 +00:00
Here are the available help topics:
Split help into multiple files and add help command
2016-07-28 19:52:31 +00:00
help: Exchange all indentations to spaces, remove trailing ws and generalize indentations (#3193) * help: Exchange all indentations to spaces and remove trailing ws * Add some missing `` marks Co-authored-by: Jöran Karl <3951388+JoeKar@users.noreply.github.com> * help: Generalize indentation levels * help: Some small visual changes - removed some superfluous whitespaces - add a line break in before an link - corrected one typo --------- Co-authored-by: Yevhen Babiichuk (DustDFG) <dfgdust@gmail.com>
2024-03-22 16:58:44 +00:00
* `tutorial`: A brief tutorial which gives an overview of all the other help
topics
* `keybindings`: Gives a full list of the default keybindings as well as how to
rebind them
* `defaultkeys`: Gives a more straight-forward list of the hotkey commands and
what they do
* `commands`: Gives a list of all the commands and what they do
* `options`: Gives a list of all the options you can customize
* `plugins`: Explains how micro's plugin system works and how to create your own
plugins
* `colors`: Explains micro's colorscheme and syntax highlighting engine and how
to create your own colorschemes or add new languages to the engine
Use more consisten syntax in md files, format tp 80 collumns, fix some typos
2017-10-11 13:16:53 +00:00
Update some docs
2019-09-02 18:40:50 +00:00
For example, to open the help page on plugins you would run `> help plugins`.
Use more consisten syntax in md files, format tp 80 collumns, fix some typos
2017-10-11 13:16:53 +00:00
I recommend looking at the `tutorial` help file because it is short for each
section and gives concrete examples of how to use the various configuration
options in micro. However, it does not give the in-depth documentation that the
other topics provide.
Reference in a new issue Copy permalink