Skip to main content

Solidity lexer for Pygments

Project description

Solidity lexer for Pygments, distributed as a PyPI package.

If you want pretty syntax highlighting in documentation for Solidity files, and you’re using Pygments, this might just be the thing for you.

Currently, Solidity keywords up to version 0.6.0 are included, to the best of my ability. MRs are welcome!

Installation

pip install pygments-lexer-solidity

Usage

Depends on doc-building infrastructure.

Sphinx

Have this in Sphinx’s conf.py:

from sphinx.highlighting import lexers
from pygments_lexer_solidity import SolidityLexer
lexers['solidity'] = SolidityLexer()

Then use .. code-block:: solidity for Solidity code blocks.

Command-line

If you just want to test a local copy of the lexer on the CLI:

% pygmentize -x -l pygments_lexer_solidity/lexer.py:SolidityLexer example.sol

License

BSD 2-clause simplified. See LICENSE.txt.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygments-lexer-solidity-0.5.0.tar.gz (6.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page