https://github.com/Alexander-Miller/i3wm-Config-Mode

https://github.com/Alexander-Miller/i3wm-Config-Mode

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/Alexander-Miller/i3wm-Config-Mode
• Owner: Alexander-Miller
• License: gpl-3.0
• Created: 2016-09-04T14:32:55.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2022-09-13T11:21:51.000Z (about 2 years ago)
• Last Synced: 2024-04-08T18:51:39.787Z (8 months ago)
• Language: Emacs Lisp
• Size: 735 KB
• Stars: 27
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • License: LICENSE

Awesome Lists containing this project

README

        
# -*- fill-column: 120 -*-

* i3wm Config Mode

An expansion of ~conf-mode~ to bring proper syntax highlighting to your i3wm config.

[[file:screenshots/screen1.png]]

** Features

This package builds on ~conf-space-mode~ (which is the major mode emacs assigns to i3wm's config file by default) and

expands its font-lock capabilities to provide proper syntax highlighting for the small language i3wm's config uses.

The new syntax highlighting faces do not define their own colours, but instead derive from Emacs' own font-locking

faces, making sure that they fit in with any theme.

Features and settings outside font-locking are not touched and will be inherited from ~conf-space-mode~.

** How to use

This mode will activate for files whose path ends with ~...i3/config~. If you use a different name, you can activate

this mode via a file-local variable by placing the line ~# -*- mode: i3wm-config -*-~ at the top of your i3wm config

file (as seen in the first screenshot).

** Known limitations

The regular expressions used here have not been tested on config files other than my own making it unlikely they will

cover all edge cases and keywords. If you find anything amiss open up an issue and I'll have it fixed.

Colour codes like ~#6699CC~ are intentionally untouched. [[https://elpa.gnu.org/packages/rainbow-mode.html][rainbow-mode]] should be used to handle colour highlighting.

** More screenshots

Before:

[[file:screenshots/before.png]]

After:

[[file:screenshots/after.png]]

With Leuven:

[[file:screenshots/leuven.png]]

With Adwaita:

[[file:screenshots/adwaita.png]]