Solidity lexer for Pygments (includes Yul intermediate language)
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.8.0 are included, to the best of my ability. MRs are welcome!
The Yul intermediate language is also supported, including for stand-alone code blocks.
Set up your virtual environment, no matter how you do it.
% virtualenv .virtualenv/`basename $(pwd)` % source .virtualenv/`basename $(pwd)`/bin/activate
Then install via PyPI:
% pip install pygments-lexer-solidity
Or from a local git repo:
% pip install -r requirements.txt % pip install -e .
Depends on doc-building infrastructure.
Have this in Sphinx’s conf.py:
from sphinx.highlighting import lexers from pygments_lexer_solidity import SolidityLexer, YulLexer lexers['solidity'] = SolidityLexer() lexers['yul'] = YulLexer()
Then use .. code-block:: solidity for Solidity code blocks, or .. code-block:: yul for Yul.
To test a local copy of the lexer on the CLI:
% pygmentize -x -l pygments_lexer_solidity/lexer.py:SolidityLexer example.sol
To generate a colorised HTML file:
% pygmentize -v -O full,style=fruity -o example.sol.html example.sol
BSD 2-clause simplified. See LICENSE.txt.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for pygments-lexer-solidity-0.7.0.tar.gz