Skip to content

Latest commit

 

History

History
84 lines (53 loc) · 4.65 KB

README.md

File metadata and controls

84 lines (53 loc) · 4.65 KB
Raw

Covert Reader for Visual Studio Code

Build Status Build Status Dependabot Status Version Installs Ratings

covert-reader-logo

Features

  • Support all the horizontal writing systems
  • Support mixing multiple languages
  • Smart word wrap (this can be quite complex for multilingual mixing)
  • Support showing line numbers
  • Support specified line number jumps (just by manually input line number in Current Line Number)
  • Support processing line separators, form feeds, etc.
  • Support identifying (informal) bullets and ellipsis dots
  • Support double quotes matching
  • Allow hiding the text line in the status bar

Installation

Open VS Code and press F1 or Ctrl + Shift + P to open command palette, select Install Extension and type vscode-covert-reader.

Or launch VS Code Quick Open (Ctrl + P), paste the following command, and press enter.

ext install vscode-covert-reader

Alternatively, in the Extensions pane, search for Covert Reader extension and install it there.

You can also install a VSIX package from our Releases page by following the Install from a VSIX instructions.

Extension Settings

This extension contributes the following settings:

  • covert-reader.currentLineNumber: The current line number of the text file (starting from 1)"
  • covert-reader.filePath: The absolute path to the text file
  • covert-reader.lineBreak: The symbol used to replace line break (default: horizontal tab)
  • covert-reader.lineLength: The maximum number of characters in one line (depends on language)

Keybindings

This extension contributes the following keybindings:

  • covert-reader.getPreviousLine: Alt+, or Option+, (only takes effect when focusing on text in the editor)
  • covert-reader.getNextLine: Alt+. or Option+. (only takes effect when focusing on text in the editor)
  • covert-reader.jumpLine: Alt+/ or Option+/
  • covert-reader.hideLine: Alt+D or Option+D

Known Issues

Not perfectly compatible with vscode-background. It may prompt you to restart VS Code.

Change Log

See the Change log for details about the changes in each version.

Support

You can find the full list of issues on the Issue Tracker. If you encounter any problems with the extension and cannot find the solution yourself (such as "Parsing file error"), please open an issue in the dedicated GitHub page: bug or feature suggestion. Before opening an issue, please make sure that it is not a duplicate.

When you do open an issue, remember to include the text file you read.

License

This extension is licensed under the MIT License.

Contributing

To contribute simply clone the repository and then commit your changes. When you do a pull requests please clearly indicate what you changed in the pull comment.

Do not update the extension version or changelog, it will be done by the maintainers when a new version is released.

If you want to update the readme, you are free to fix typos, errors, add or improve descriptions, but if you have a style change in mind please use an issue (or specific pull request) so that it can be discussed.

Credits