README.md

INI Syntax

A package for Sublime Text that provides syntax highlighting for INI and related file types like Windows Registry (.reg) files.

Installation

The package can be installed via Sublime Text's package manager Package Control. From the command palette choose Package Control: Install Package and search for INI.

Features

You can navigate between sections in opened INI files via Sublime's Goto Symbol... feature from the menu or with the keyboard shortcut Ctrl+R (⌘+R on macOS).

Customization

Syntax highlighting

Following the naming conventions for key-value pairs, the scopes meta.mapping.key.ini string and meta.mapping.value.ini string are applied for keys and string values, respectively. If you prefer different highlighting colors for key names and values, ensure to use a color scheme which targets one of these scopes to distinguish between them. You can easily add such a rule as a customization to your color scheme, as described in the official documentation. For example, if you want keys to be highlighted with the same color as keywords in Mariana, create a file Mariana.sublime-color-scheme in your Packages/User directory with the following content:

{
    "rules": [
        {
            "scope": "meta.mapping.key.ini string",
            "foreground": "var(pink)"
        }
    ]
}

Comment toggling

The default character used by the "toggle comment" functionality (Ctrl+/) in INI files is a semicolon. If you prefer to use # instead, you can achieve that by adding a custom key binding with a "variant": 2 argument for the toggle_comment command (this requires Sublime Text build 4130 or later):

{
    "keys": ["ctrl+/"],
    "command": "toggle_comment",
    "args": {"block": false, "variant": 2},
    "context": [{"key": "selector", "operand": "source.ini"}]
}