summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMorten Enemark Lund <melund@gmail.com>2018-08-04 19:43:17 +0200
committerMorten Enemark Lund <melund@gmail.com>2018-08-04 19:43:17 +0200
commit9ddc62fd449592eaee42b4026884b976b2fb3b64 (patch)
treeb03ae20866556ba0b14e12d263d94473666302c0 /doc
parent0db8e281af377923115b894703b2b8beb8f1e9d5 (diff)
downloadpygments-9ddc62fd449592eaee42b4026884b976b2fb3b64.tar.gz
Change ansi color names to more saying names
The ansi color names are changed to names which are easier to understand and align with color names of other projects and terminals. (e.g. ``#ansifuchsia`` to ``ansibrightmagenta``) This also drops the # prefix to the color names. Hashtag # is usually used for hex colors and the names are already prefixed with `ansi`. Furthermore, it allows the new and old set of names to be exclusive.
Diffstat (limited to 'doc')
-rw-r--r--doc/docs/styles.rst49
1 files changed, 41 insertions, 8 deletions
diff --git a/doc/docs/styles.rst b/doc/docs/styles.rst
index 1094a270..cd0144ab 100644
--- a/doc/docs/styles.rst
+++ b/doc/docs/styles.rst
@@ -153,17 +153,17 @@ Terminal Styles
.. versionadded:: 2.2
Custom styles used with the 256-color terminal formatter can also map colors to
-use the 8 default ANSI colors. To do so, use ``#ansigreen``, ``#ansired`` or
+use the 8 default ANSI colors. To do so, use ``ansigreen``, ``ansibrightred`` or
any other colors defined in :attr:`pygments.style.ansicolors`. Foreground ANSI
colors will be mapped to the corresponding `escape codes 30 to 37
<https://en.wikipedia.org/wiki/ANSI_escape_code#Colors>`_ thus respecting any
custom color mapping and themes provided by many terminal emulators. Light
variants are treated as foreground color with and an added bold flag.
-``bg:#ansi<color>`` will also be respected, except the light variant will be the
+``bg:ansi<color>`` will also be respected, except the light variant will be the
same shade as their dark variant.
See the following example where the color of the string ``"hello world"`` is
-governed by the escape sequence ``\x1b[34;01m`` (Ansi Blue, Bold, 41 being red
+governed by the escape sequence ``\x1b[34;01m`` (Ansi bright blue, Bold, 41 being red
background) instead of an extended foreground & background color.
.. sourcecode:: pycon
@@ -176,7 +176,7 @@ background) instead of an extended foreground & background color.
>>> class MyStyle(Style):
styles = {
- Token.String: '#ansiblue bg:#ansired',
+ Token.String: 'ansibrightblue bg:ansibrightred',
}
>>> code = 'print("Hello World")'
@@ -184,18 +184,51 @@ background) instead of an extended foreground & background color.
>>> print(result.encode())
b'\x1b[34;41;01m"\x1b[39;49;00m\x1b[34;41;01mHello World\x1b[39;49;00m\x1b[34;41;01m"\x1b[39;49;00m'
-Colors specified using ``#ansi*`` are converted to a default set of RGB colors
+Colors specified using ``ansi*`` are converted to a default set of RGB colors
when used with formatters other than the terminal-256 formatter.
By definition of ANSI, the following colors are considered "light" colors, and
will be rendered by most terminals as bold:
-- "darkgray", "red", "green", "yellow", "blue", "fuchsia", "turquoise", "white"
+- "brightblack" (darkgrey), "brightred", "brightgreen", "brightyellow", "brightblue",
+ "brightmagenta", "brightcyan", "white"
The following are considered "dark" colors and will be rendered as non-bold:
-- "black", "darkred", "darkgreen", "brown", "darkblue", "purple", "teal",
- "lightgray"
+- "black", "red", "green", "yellow", "blue", "magenta", "cyan",
+ "gray"
Exact behavior might depends on the terminal emulator you are using, and its
settings.
+
+.. _NewAnsiColorNames:
+
+.. versionchanged:: 2.3
+
+The definition of the ansi color names has changed.
+New names are easier to understand and align to the colors used in other projects.
+
+
++-------------------------+--------------------------+
+| New names | Pygments 2.2 |
++=======================+============================+
+| ``ansiblack`` | ``#ansiblack`` |
+| ``ansired`` | ``#ansidarkred`` |
+| ``ansigreen`` | ``#ansidarkgreen`` |
+| ``ansiyellow`` | ``#ansibrown`` |
+| ``ansiblue`` | ``#ansidarkblue`` |
+| ``ansimagenta`` | ``#ansipurple`` |
+| ``ansicyan`` | ``#ansiteal`` |
+| ``ansigray`` | ``#ansilightgray`` |
+| ``ansibrightblack`` | ``#ansidarkgray`` |
+| ``ansibrightred`` | ``#ansired`` |
+| ``ansibrightgreen`` | ``#ansigreen`` |
+| ``ansibrightyellow`` | ``#ansiyellow`` |
+| ``ansibrightblue`` | ``#ansiblue`` |
+| ``ansibrightmagenta`` | ``#ansifuchsia`` |
+| ``ansibrightcyan`` | ``#ansiturquoise`` |
+| ``ansiwhite`` | ``#ansiwhite`` |
++=========================+==========================+
+
+Old ansi color names are deprecated but will still work.
+