Edditoria/tmux-sublime

Tmux 3 syntax highlighting for Sublime Text and Bat CLI. MIT licensed for sharing.

โ˜… 2Forks 0GitHub โ†—Compare
batsublime-textsyntax-highlightingtmux

README

Tmux 3 Syntax for Sublime Text and bat

This project provides syntax definition for scripting Tmux configuration.

What

These are what this project does:

  • Syntax highlighting for ๐Ÿ“tmux.conf.
  • Compatible with Sublime Text 3 and 4.
  • Works with bat command-line tool.
  • Supports syntax of Tmux 3.
  • Written in .sublime-syntax rather than .tmLanguage.
  • MIT licensed-free to use, modify and share.

How

Install for Sublime Text

screeshot showing Tmux config for Sublime Text

Clone this repository into your ๐Ÿ“Package/ folder:

git clone https://github.com/Edditoria/tmux-sublime.git

Tip

To find the path of ๐Ÿ“Package/, click "Preferences" โ†’ "Browse Packages" on menu bar of Sublime Text.

Restart Sublime Text if necessary.

Install for bat CLI

screeshot showing Tmux config for bat CLI

Clone this repository into your ๐Ÿ“bat/syntaxes/ directory:

mkdir -p "$(bat --config-dir)/syntaxes"
cd "$(bat --config-dir)/syntaxes"
git clone https://github.com/Edditoria/tmux-sublime.git

# Parse into a binary cache
bat cache --build

Why

I want to include my ๐Ÿ“bat.conf in my dotfiles without licensing concerns. So, I can bat tmux.conf # with wings across my machines. Unfortunately I couldn't find any good and safe project on GitHub.

Fine. I do it myself.

Status

  • I create it to "show something" on screen using bat. The code is definitely over-simplified currently.
  • I would maintain usability in Sublime Text. I don't know how far I can go. It depends on user demand: You!
  • Please star this project to notify me to support more.
  • Open issues for requests and improvements.

Thank you, open source!