9e216da9ef
After go1.16, go will use module mode by default, even when the repository is checked out under GOPATH or in a one-off directory. Add go.mod, go.sum to keep this repo buildable without opting out of the module mode. > go mod init github.com/mmcgrana/gobyexample > go mod tidy > go mod vendor In module mode, the 'vendor' directory is special and its contents will be actively maintained by the go command. pygments aren't the dependency the go will know about, so it will delete the contents from vendor directory. Move it to `third_party` directory now. And, vendor the blackfriday package. Note: the tutorial contents are not affected by the change in go1.16 because all the examples in this tutorial ask users to run the go command with the explicit list of files to be compiled (e.g. `go run hello-world.go` or `go build command-line-arguments.go`). When the source list is provided, the go command does not have to compute the build list and whether it's running in GOPATH mode or module mode becomes irrelevant.
146 lines
4.0 KiB
ReStructuredText
146 lines
4.0 KiB
ReStructuredText
.. -*- mode: rst -*-
|
|
|
|
======
|
|
Styles
|
|
======
|
|
|
|
Pygments comes with some builtin styles that work for both the HTML and
|
|
LaTeX formatter.
|
|
|
|
The builtin styles can be looked up with the `get_style_by_name` function:
|
|
|
|
.. sourcecode:: pycon
|
|
|
|
>>> from pygments.styles import get_style_by_name
|
|
>>> get_style_by_name('colorful')
|
|
<class 'pygments.styles.colorful.ColorfulStyle'>
|
|
|
|
You can pass a instance of a `Style` class to a formatter as the `style`
|
|
option in form of a string:
|
|
|
|
.. sourcecode:: pycon
|
|
|
|
>>> from pygments.styles import get_style_by_name
|
|
>>> from pygments.formatters import HtmlFormatter
|
|
>>> HtmlFormatter(style='colorful').style
|
|
<class 'pygments.styles.colorful.ColorfulStyle'>
|
|
|
|
Or you can also import your own style (which must be a subclass of
|
|
`pygments.style.Style`) and pass it to the formatter:
|
|
|
|
.. sourcecode:: pycon
|
|
|
|
>>> from yourapp.yourmodule import YourStyle
|
|
>>> from pygments.formatters import HtmlFormatter
|
|
>>> HtmlFormatter(style=YourStyle).style
|
|
<class 'yourapp.yourmodule.YourStyle'>
|
|
|
|
|
|
Creating Own Styles
|
|
===================
|
|
|
|
So, how to create a style? All you have to do is to subclass `Style` and
|
|
define some styles:
|
|
|
|
.. sourcecode:: python
|
|
|
|
from pygments.style import Style
|
|
from pygments.token import Keyword, Name, Comment, String, Error, \
|
|
Number, Operator, Generic
|
|
|
|
class YourStyle(Style):
|
|
default_style = ""
|
|
styles = {
|
|
Comment: 'italic #888',
|
|
Keyword: 'bold #005',
|
|
Name: '#f00',
|
|
Name.Function: '#0f0',
|
|
Name.Class: 'bold #0f0',
|
|
String: 'bg:#eee #111'
|
|
}
|
|
|
|
That's it. There are just a few rules. When you define a style for `Name`
|
|
the style automatically also affects `Name.Function` and so on. If you
|
|
defined ``'bold'`` and you don't want boldface for a subtoken use ``'nobold'``.
|
|
|
|
(Philosophy: the styles aren't written in CSS syntax since this way
|
|
they can be used for a variety of formatters.)
|
|
|
|
`default_style` is the style inherited by all token types.
|
|
|
|
To make the style usable for Pygments, you must
|
|
|
|
* either register it as a plugin (see :doc:`the plugin docs <plugins>`)
|
|
* or drop it into the `styles` subpackage of your Pygments distribution one style
|
|
class per style, where the file name is the style name and the class name is
|
|
`StylenameClass`. For example, if your style should be called
|
|
``"mondrian"``, name the class `MondrianStyle`, put it into the file
|
|
``mondrian.py`` and this file into the ``pygments.styles`` subpackage
|
|
directory.
|
|
|
|
|
|
Style Rules
|
|
===========
|
|
|
|
Here a small overview of all allowed styles:
|
|
|
|
``bold``
|
|
render text as bold
|
|
``nobold``
|
|
don't render text as bold (to prevent subtokens being highlighted bold)
|
|
``italic``
|
|
render text italic
|
|
``noitalic``
|
|
don't render text as italic
|
|
``underline``
|
|
render text underlined
|
|
``nounderline``
|
|
don't render text underlined
|
|
``bg:``
|
|
transparent background
|
|
``bg:#000000``
|
|
background color (black)
|
|
``border:``
|
|
no border
|
|
``border:#ffffff``
|
|
border color (white)
|
|
``#ff0000``
|
|
text color (red)
|
|
``noinherit``
|
|
don't inherit styles from supertoken
|
|
|
|
Note that there may not be a space between ``bg:`` and the color value
|
|
since the style definition string is split at whitespace.
|
|
Also, using named colors is not allowed since the supported color names
|
|
vary for different formatters.
|
|
|
|
Furthermore, not all lexers might support every style.
|
|
|
|
|
|
Builtin Styles
|
|
==============
|
|
|
|
Pygments ships some builtin styles which are maintained by the Pygments team.
|
|
|
|
To get a list of known styles you can use this snippet:
|
|
|
|
.. sourcecode:: pycon
|
|
|
|
>>> from pygments.styles import STYLE_MAP
|
|
>>> STYLE_MAP.keys()
|
|
['default', 'emacs', 'friendly', 'colorful']
|
|
|
|
|
|
Getting a list of available styles
|
|
==================================
|
|
|
|
.. versionadded:: 0.6
|
|
|
|
Because it could be that a plugin registered a style, there is
|
|
a way to iterate over all styles:
|
|
|
|
.. sourcecode:: pycon
|
|
|
|
>>> from pygments.styles import get_all_styles
|
|
>>> styles = list(get_all_styles())
|