search

dandavison / delta

A syntax-highlighting pager for git, diff, grep, and blame output
https://dandavison.github.io/delta/
MIT License
23.09k stars 382 forks source link

🚀 Please provide documentation how to enable a syntax theme of `bat` #1050

Open MaxG87 opened 2 years ago

MaxG87 commented 2 years ago 
$ delta --version
delta 0.12.1
$ delta --list-syntax-themes
Light syntax themes:
    GitHub
    Monokai Extended Light
    OneHalfLight
    Solarized (light)
    gruvbox-light

Dark syntax themes:
    1337
    Coldark-Cold
    Coldark-Dark
    DarkNeon
    Dracula
    Monokai Extended
    Monokai Extended Bright
    Monokai Extended Origin
    Nord
    OneHalfDark
    Solarized (dark)
    Sublime Snazzy
    TwoDark
    Visual Studio Dark+
    ansi
    base16
    base16-256
    gruvbox-dark
    zenburn

Use delta --show-syntax-themes to demo the themes.

I found git-delta on Hacker News and wanted to give it a try. The example configuration was easy enough to set up.

However, the default colour scheme is not great. I wanted to set up OneHalfLight, which is listed as available theme. I spend quite some time trying to figure that out. Unfortunately I couldn't find an example or explanation in your documentation and I could not find anything using a search engine neither.

Since delta advertises itself as using bat's builtin themes, I think it would be fitting to explicitly demonstrate how to configure one.

dandavison commented 2 years ago

Hi @MaxG87 I think you're right that this could be more explicit in the user manual: https://dandavison.github.io/delta/configuration.html?search=syntax-theme

However, have you consulted delta --help? That is the point-of-truth for delta configuration options. See:

        --syntax-theme <SYNTAX_THEME>
            The syntax-highlighting theme to use.

            Use --show-syntax-themes to demo available themes. Defaults to the value of the BAT_THEME environment variable, if that contains a valid theme name. --syntax-theme=none disables all syntax highlighting.

and there is an example further down in the --help output

    syntax-theme = Dracula
    plus-style = bold syntax "#002800"

In gitconfig you do not need to quote a syntax theme even if it contains spaces. (But on the shell command line you would of course need to quote a string containing spaces)

MaxG87 commented 2 years ago

Sorry, I missed that. I was a bit overwhelmed by the configurability. In particular I searched for style pretty long, noticed they are related to features, and finally noticed it should be themes. Then I gave up. Until your reply I wasn't even aware I should configure --syntax-theme.

Anyhow, your reply really helped me. Thank you very much.