{"author":"Flavio Curella","author_email":"flavio.curella@gmail.com","bugtrack_url":null,"classifiers":["Environment :: Plugins","Intended Audience :: Developers","Programming Language :: Python :: 3"],"description":"jsx-lexer\n=========\n\n.. image:: https://travis-ci.org/fcurella/jsx-lexer.svg?branch=master\n :target: https://travis-ci.org/fcurella/jsx-lexer\n\n.. image:: https://coveralls.io/repos/github/fcurella/jsx-lexer/badge.svg?branch=master\n :target: https://coveralls.io/github/fcurella/jsx-lexer?branch=master\n\nA JSX lexer for Pygments\n\nInstallation\n------------\n.. code-block:: sh\n\n $ pip install jsx-lexer\n\nUsage with Sphinx\n-----------------\n\nTo use within Sphinx, simply specify ``jsx`` for your ``code-block``::\n\n .. code-block:: jsx\n\n const BlogTitle = ({ children }) => (\n

{children}

\n );\n // class component\n class BlogPost extends React.Component {\n renderTitle(title) {\n return {title}\n };\n render() {\n return (\n

\n {this.renderTitle(this.props.title)}\n

{this.props.body}

\n );\n }\n }\n\nUsage with mkdocs\n-----------------\n\nFirst, you need to create the ``CSS`` for the highlighting:\n\n.. code-block:: bash\n\n $ pygmentize -S default -f html -a .codehilite > code/pygments.css\n\nThen, add the following to your ``mkdocs.yml``:\n\n.. code-block:: yaml\n\n markdown_extensions:\n - codehilite\n extra_css: [pygments.css]\n\nNow, you can use ``jsx`` in your code blocks::\n\n ```jsx\n const BlogTitle = ({ children }) => (\n

{children}

\n );\n // class component\n class BlogPost extends React.Component {\n renderTitle(title) {\n return {title}\n };\n render() {\n return (\n

\n {this.renderTitle(this.props.title)}\n

{this.props.body}

\n );\n }\n }\n ```\n\nUsage with Overleaf\n-------------------\n\nFirst, add the minted package in your main file:\n\n.. code-block:: latex\n\n \\usepackage{minted}\n\nThen, download the `lexer.py`_ file from this project, and place it in your root folder in Overleaf.\n\n.. _lexer.py: jsx/lexer.py\n\nNow, you can use ``{lexer.py:JsxLexer -x}`` in front of your minted code blocks:\n\n.. code-block:: latex\n\n \\begin{minted}{lexer.py:JsxLexer -x}\n const BlogTitle = ({ children }) => (\n

{children}

\n );\n // class component\n class BlogPost extends React.Component {\n renderTitle(title) {\n return {title}\n };\n render() {\n return (\n

\n {this.renderTitle(this.props.title)}\n

{this.props.body}

\n );\n }\n }\n \\end{minted}\n\nYou can find an example of the lexer in use on Overleaf here: `https://www.overleaf.com/read/xvsytqzkvdjb`\n","description_content_type":"","docs_url":null,"download_url":"","downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/fcurella/jsx-lexer","keywords":"pygments highlight jsx react","license":"MIT License","license_expression":null,"license_files":null,"maintainer":"","maintainer_email":"","name":"jsx-lexer","package_url":"https://pypi.org/project/jsx-lexer/","platform":null,"project_url":"https://pypi.org/project/jsx-lexer/","project_urls":{"Homepage":"https://github.com/fcurella/jsx-lexer"},"provides_extra":null,"release_url":"https://pypi.org/project/jsx-lexer/2.0.1/","requires_dist":["Pygments (>=2.12.0)"],"requires_python":"","summary":"A JSX lexer for Pygments","version":"2.0.1","yanked":false,"yanked_reason":null}

Package search

jsx-lexer

project_urls

Dependencies

All package metadata

Releases