Skip to content

NathanRoyer/hop-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hop Editor

This project aims to provide a terminal-based text and code editor, taking a lot of inspiration from Sublime Text.

screenshot

Features

  • pin folders to a file tree
  • explore these folders and open files for edition
  • edit multiple files via tabs
  • cheap syntax highlighting
  • intuitive mouse support
  • some context-menus
  • clipboard support
  • multi-cursor

Installation

Option A: Download the x86_64/linux pre-built binary

Please go to the 'releases' section of this git repository.

Option B: Build from the rust package registry

  1. Install Rust: https://www.rust-lang.org/tools/install
  2. Run cargo install hop-editor

Option C: Build from sources

  1. Install Rust: https://www.rust-lang.org/tools/install
  2. Clone this repository
  3. From the newly created directory, run cargo install --path .

How To Use

See how-to-use.md in the assets folder.

Using the Clipboard

hop relies on external executables for clipboard management. If this is a problem for you, try setting internal-clipboard to true in your config.

Copying with Ctrl + C

  • hop will try to copy using wl-copy, then using xclip, then using pbcopy.

Pasting with Ctrl + V

  • hop will try to paste using wl-paste, then using xclip, then using pbpaste.

When Ctrl+Shift+V is pressed, your terminal should spontaneously input characters from a clipboard as if they were pressed; hop does nothing special in this process.

Configuration

The path of the configuration file can be specified with the -c argument. By default, this path is ~/.config/hop.toml.

Please check out the default config file in assets from the git repo. There you will also find a default syntax file.

TOML Contents

  • internal-clipboard: set to true if you don't want to use the system-wide clipboard
  • max-cursor-lines: max number of lines that the cursor list can take in left panel
  • hide-folders: list of folders to hide in the file tree
  • syntax-file: path to a syntax file for syntax highligting
  • tree-width: number of columns for the file tree
  • background: hexadecimal color code for the background
  • syntax: map of syntax token types to hexadecimal color codes
  • hover: hexadecimal color code for hovering color (tree & tabs)

Contributing

I openly accept PRs for syntax highlighting changes.

For everything else, please file an issue first.

About

terminal code editor

Resources

Stars

Watchers

Forks

Contributors

Languages