mirror of
https://github.com/RGBCube/serenity
synced 2025-05-16 18:55:07 +00:00

Through links in the help page, the user can directly launch the app whose help page is currently viewed. The idea for this feature came up in the discussion of #11557 (https://github.com/SerenityOS/serenity/pull/11557#issuecomment-1004830728 ). The intention is that the user can simply open the app they are currently trying to understand, and play around with it, learn by doing, or follow along with any guide that may be present in the help page. It feels very great :^)
31 lines
637 B
Markdown
31 lines
637 B
Markdown
## Name
|
|
|
|
TextEditor - SerenityOS text editor
|
|
|
|
[Open](file:///bin/TextEditor)
|
|
|
|
## Synopsis
|
|
|
|
```**sh
|
|
$ TextEditor [--preview-mode mode] [file[:line[:column]]]
|
|
```
|
|
|
|
## Description
|
|
|
|
TextEditor is a text document editor for SerenityOS featuring a preview mode
|
|
which allows automatic live rendering of HTML and Markdown documents.
|
|
|
|
## Options
|
|
|
|
* `--preview-mode mode`: Preview mode, one of 'none', 'html', 'markdown', 'auto'
|
|
|
|
## Arguments
|
|
|
|
* `file[:line[:column]]`: File to edit, with optional starting line and column number
|
|
|
|
## Examples
|
|
|
|
```sh
|
|
$ TextEditor /home/anon/Documents/emoji.txt
|
|
$ TextEditor /home/anon/Documents/emoji.txt:5:12
|
|
```
|