Small Documentation Improvement (#3786)

This commit is contained in:
cutelisp
2025-07-25 20:02:33 +01:00
committed by GitHub
parent d7e43d4974
commit f97cba34d2
5 changed files with 14 additions and 15 deletions

View File

@@ -1,7 +1,6 @@
# See http://editorconfig.org # See https://editorconfig.org
# In Go files we indent with tabs but still # In Go files we indent with tabs but still
# set indent_size to control the GitHub web viewer. # set indent_size to control the GitHub web viewer.
[*.go] [*.go]
indent_size=4 indent_size=4

View File

@@ -142,7 +142,7 @@ for other operating systems. These packages are not guaranteed to be up-to-date.
* `winget install zyedidia.micro` * `winget install zyedidia.micro`
* OpenBSD: Available in the ports tree and also available as a binary package. * OpenBSD: Available in the ports tree and also available as a binary package.
* `pkg_add -v micro`. * `pkg_add -v micro`.
* NetBSD, macOS, Linux, Illumos, etc. with [pkgsrc](http://www.pkgsrc.org/)-current: * NetBSD, macOS, Linux, Illumos, etc. with [pkgsrc](https://www.pkgsrc.org/)-current:
* `pkg_add micro` * `pkg_add micro`
* macOS: Available in package managers. * macOS: Available in package managers.
* `sudo port install micro` (with [MacPorts](https://www.macports.org)) * `sudo port install micro` (with [MacPorts](https://www.macports.org))
@@ -196,7 +196,7 @@ Native macOS builds are done with `CGO_ENABLED=1` forced set to support adding t
### macOS terminal ### macOS terminal
If you are using macOS, you should consider using [iTerm2](http://iterm2.com/) instead of the default terminal (Terminal.app). The iTerm2 terminal has much better mouse support as well as better handling of key events. For best keybinding behavior, choose `xterm defaults` under `Preferences->Profiles->Keys->Presets...`, and select `Esc+` for `Left Option Key` in the same menu. The newest versions also support true color. If you are using macOS, you should consider using [iTerm2](https://iterm2.com/) instead of the default terminal (Terminal.app). The iTerm2 terminal has much better mouse support as well as better handling of key events. For best keybinding behavior, choose `xterm defaults` under `Preferences->Profiles->Keys->Presets...`, and select `Esc+` for `Left Option Key` in the same menu. The newest versions also support true color.
If you still insist on using the default Mac terminal, be sure to set `Use Option key as Meta key` under If you still insist on using the default Mac terminal, be sure to set `Use Option key as Meta key` under
`Preferences->Profiles->Keyboard` to use <kbd>option</kbd> as <kbd>alt</kbd>. `Preferences->Profiles->Keyboard` to use <kbd>option</kbd> as <kbd>alt</kbd>.

View File

@@ -23,7 +23,7 @@ Here is a list of terminal emulators and their status:
* `st`: supported. * `st`: supported.
* `rxvt-unicode`: not natively supported, but there is a Perl extension * `rxvt-unicode`: not natively supported, but there is a Perl extension
[here](http://anti.teamidiot.de/static/nei/*/Code/urxvt/). [here](https://anti.teamidiot.de/static/nei/*/Code/urxvt/).
* `xterm`: supported, but disabled by default. It can be enabled by putting * `xterm`: supported, but disabled by default. It can be enabled by putting
the following in `.Xresources` or `.Xdefaults`: the following in `.Xresources` or `.Xdefaults`:

View File

@@ -509,8 +509,8 @@ Micro also has a built in plugin manager, which you can invoke with the
For the valid commands you can use, see the `commands` help topic. For the valid commands you can use, see the `commands` help topic.
The manager fetches plugins from the channels (which is simply a list of plugin The manager fetches plugins from the channels (which is simply a list of plugin
metadata) which it knows about. By default, micro only knows about the official metadata) which it knows about. By default, micro only knows about the [official
channel which is located at github.com/micro-editor/plugin-channel but you can channel](https://github.com/micro-editor/plugin-channel) but you can
add your own third-party channels using the `pluginchannels` option and you can add your own third-party channels using the `pluginchannels` option and you can
directly link third-party plugins to allow installation through the plugin directly link third-party plugins to allow installation through the plugin
manager with the `pluginrepos` option. manager with the `pluginrepos` option.
@@ -537,9 +537,9 @@ This file will contain the metadata for your plugin. Here is an example:
}] }]
``` ```
Then open a pull request at github.com/micro-editor/plugin-channel, adding a Then open a pull request at the [official plugin channel](https://github.com/micro-editor/plugin-channel),
link to the raw `repo.json` that is in your plugin repository. adding a link to the raw `repo.json` that is in your plugin repository.
To make updating the plugin work, the first line of your plugin's lua code To make updating the plugin work, the first line of your plugin's lua code
should contain the version of the plugin. (Like this: `VERSION = "1.0.0"`) should contain the version of the plugin. (Like this: `VERSION = "1.0.0"`)
Please make sure to use [semver](http://semver.org/) for versioning. Please make sure to use [semver](https://semver.org/) for versioning.

View File

@@ -5,19 +5,19 @@ detect:
rules: rules:
- identifier: "\\b[A-Z][0-9a-z_]*\\b" - identifier: "\\b[A-Z][0-9a-z_]*\\b"
# See: http://erlang.org/doc/reference_manual/data_types.html # See: https://erlang.org/doc/reference_manual/data_types.html
- constant.number: "\\b[0-9]+(\\.[0-9]+)?(e-?[0-9]+)?\\b" - constant.number: "\\b[0-9]+(\\.[0-9]+)?(e-?[0-9]+)?\\b"
- constant.number: "\\b[0-9]{1,2}\\#[a-zA-Z0-9]+\\b" - constant.number: "\\b[0-9]{1,2}\\#[a-zA-Z0-9]+\\b"
- constant.bool: "\\b(true|false)\\b" - constant.bool: "\\b(true|false)\\b"
- constant.number: "\\$\\\\?\\S{1}" - constant.number: "\\$\\\\?\\S{1}"
# See: http://erlang.org/doc/reference_manual/introduction.html # See: https://erlang.org/doc/reference_manual/introduction.html
- statement: "\\b(after|and|andalso|band|begin|bnot|bor|bsl|bsr|bxor|case|catch|cond|div|end|fun|if|let|not|of|or|orelse|receive|rem|try|when|xor)\\b" - statement: "\\b(after|and|andalso|band|begin|bnot|bor|bsl|bsr|bxor|case|catch|cond|div|end|fun|if|let|not|of|or|orelse|receive|rem|try|when|xor)\\b"
# See: http://erlang.org/doc/reference_manual/macros.html # See: https://erlang.org/doc/reference_manual/macros.html
- preproc: "\\-(module|export|record|include|include_lib|define|undef|ifdef|ifndef|else|endif|if|elif|error|warning)\\b" - preproc: "\\-(module|export|record|include|include_lib|define|undef|ifdef|ifndef|else|endif|if|elif|error|warning)\\b"
- identifier.macro: "\\?[A-Z0-9_]+\\b" - identifier.macro: "\\?[A-Z0-9_]+\\b"
# See: http://erlang.org/doc/man/erlang.html # See: https://erlang.org/doc/man/erlang.html
- special: "\\b(ext_binary|binary|iovec|message_queue_data|time(_unit|stamp)|abs|apply|atom(_to_binary|_to_list)|binary_(part|to_atom|to_existing_atom|to_float|to_integer|to_list|to_term)|bit(_size|string_to_list)|byte_size|ceil|check_(old_code|process_code)|date|delete_module|demonitor|disconnect_node|element|erase|error|exit|float(_to_binary|_to_list)?|floor|garbage_collect|get|group_leader|halt|integer(_to_binary|to_list)|iolist_(size|to_binary)|is_(alive|atom|binary|bitstring|boolean|float|function|integer|list|map|map_key|number|pid|port|process_alive|record|reference|tuple|length)|link|list_to_(atom|binary|bitstring|existing_atom|float|integer|pid|port|ref|tuple)|load_module|make_ref|map_(get|size)|max|min|module_loaded|monitor(_node)?|nodes?|now|open_port|pid_to_list|port(_close|command|connect|control|to_list)|pre_loaded|process(_flag|_info|es)|purge_module|put|register(ed)?|round|self|setelement|size|spawn(_link|_monitor|_opt|_binary)?|statistics|trunc|tuple_(size|to_list)|unlink|unregister|whereis)\\b" - special: "\\b(ext_binary|binary|iovec|message_queue_data|time(_unit|stamp)|abs|apply|atom(_to_binary|_to_list)|binary_(part|to_atom|to_existing_atom|to_float|to_integer|to_list|to_term)|bit(_size|string_to_list)|byte_size|ceil|check_(old_code|process_code)|date|delete_module|demonitor|disconnect_node|element|erase|error|exit|float(_to_binary|_to_list)?|floor|garbage_collect|get|group_leader|halt|integer(_to_binary|to_list)|iolist_(size|to_binary)|is_(alive|atom|binary|bitstring|boolean|float|function|integer|list|map|map_key|number|pid|port|process_alive|record|reference|tuple|length)|link|list_to_(atom|binary|bitstring|existing_atom|float|integer|pid|port|ref|tuple)|load_module|make_ref|map_(get|size)|max|min|module_loaded|monitor(_node)?|nodes?|now|open_port|pid_to_list|port(_close|command|connect|control|to_list)|pre_loaded|process(_flag|_info|es)|purge_module|put|register(ed)?|round|self|setelement|size|spawn(_link|_monitor|_opt|_binary)?|statistics|trunc|tuple_(size|to_list)|unlink|unregister|whereis)\\b"
# See: http://erlang.org/doc/reference_manual/data_types.html#atom # See: https://erlang.org/doc/reference_manual/data_types.html#atom
- symbol: - symbol:
start: "'" start: "'"
end: "'" end: "'"