dandavison/delta
1
1
Fork 0
mirror of https://github.com/dandavison/delta.git synced 2024-10-05 04:17:21 +03:00
Code Issues Projects Releases Wiki Activity

Edit README

Browse Source
This commit is contained in:
Dan Davison 2020-08-03 22:12:07 -04:00
parent 49400c7cc4
commit 648f676dc7
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -73,7 +73,6 @@ Contents
* [Installation](#installation)
* [Configuration](#configuration)
* [Usage](#usage)
* [Supported languages and themes](#supported-languages-and-themes)
* [Choosing colors (styles)](#choosing-colors-styles)
* [Line numbers](#line-numbers)
* [Side-by-side view](#side-by-side-view)
@ -85,6 +84,7 @@ Contents
* [Using Delta on Windows](#using-delta-on-windows)
* [Mouse scrolling](#mouse-scrolling)
* [Using Delta with Magit](#using-delta-with-magit)
* [Supported languages and themes](#supported-languages-and-themes)
* [Comparisons with other tools](#comparisons-with-other-tools)
* [Build delta from source](#build-delta-from-source)
* [Related projects](#related-projects)
@ -243,7 +243,7 @@ Alternatively, delta is available in the following package managers:
## Configuration
Set delta to be git's pager in your `.gitconfig`. Delta accepts many command line options to alter colors and other details of the output. An example is
Set delta to be git's pager in your `.gitconfig`. Delta has many options to alter colors and other details of the output. An example is
```gitconfig
[core]
pager = delta
@ -279,18 +279,6 @@ diff -u a.txt b.txt | delta
## Usage
### Supported languages and themes
To list the supported languages and color themes, use `delta --list-languages` and `delta --list-syntax-themes`. To see a demo of the color themes, use `delta --show-syntax-themes`:
To add your own custom color theme, or language, please follow the instructions in the Customization section of the [bat documentation](https://github.com/sharkdp/bat/#customization):
- [Adding a custom language](https://github.com/sharkdp/bat/#adding-new-syntaxes--language-definitions)
- [Adding a custom theme](https://github.com/sharkdp/bat/#adding-new-themes)
Delta automatically recognizes custom themes and languages added to bat. You will need to install bat in order to run the `bat cache --build` command.
The languages and color themes that ship with delta are those that ship with bat. So, to propose a new language or color theme for inclusion in delta, it would need to be a helpful addition to bat, in which case please open a PR against bat.
### Choosing colors (styles)
All options that have a name like `--*-style` work in the same way. It is very similar to how
@ -440,6 +428,18 @@ Delta can be used when displaying diffs in the Magit git client: see [magit-delt
<table><tr><td><img width=500px src="https://user-images.githubusercontent.com/52205/79934267-2acb2e00-8420-11ea-8bc4-546508fd3581.png" alt="image" /></td></tr></table>
### Supported languages and themes
To list the supported languages and color themes, use `delta --list-languages` and `delta --list-syntax-themes`. To see a demo of the color themes, use `delta --show-syntax-themes`:
To add your own custom color theme, or language, please follow the instructions in the Customization section of the [bat documentation](https://github.com/sharkdp/bat/#customization):
- [Adding a custom language](https://github.com/sharkdp/bat/#adding-new-syntaxes--language-definitions)
- [Adding a custom theme](https://github.com/sharkdp/bat/#adding-new-themes)
Delta automatically recognizes custom themes and languages added to bat. You will need to install bat in order to run the `bat cache --build` command.
The languages and color themes that ship with delta are those that ship with bat. So, to propose a new language or color theme for inclusion in delta, it would need to be a helpful addition to bat, in which case please open a PR against bat.
## Comparisons with other tools
(`delta --light`)