{"id":15445233,"url":"https://github.com/jhermann/pygments-markdown-lexer","last_synced_at":"2025-04-19T20:40:58.649Z","repository":{"id":31588627,"uuid":"35153429","full_name":"jhermann/pygments-markdown-lexer","owner":"jhermann","description":":construction: [BETA, not feature complete] A Markdown lexer for Pygments to highlight Markdown code snippets.","archived":false,"fork":false,"pushed_at":"2018-03-18T10:13:11.000Z","size":73,"stargazers_count":19,"open_issues_count":4,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-29T13:11:13.912Z","etag":null,"topics":["markdown","pygments-lexer","syntax-highlighting"],"latest_commit_sha":null,"homepage":"https://pygments-markdown-lexer.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jhermann.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-05-06T10:27:28.000Z","updated_at":"2025-01-18T12:13:41.000Z","dependencies_parsed_at":"2022-09-02T16:49:41.698Z","dependency_job_id":null,"html_url":"https://github.com/jhermann/pygments-markdown-lexer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhermann%2Fpygments-markdown-lexer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhermann%2Fpygments-markdown-lexer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhermann%2Fpygments-markdown-lexer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jhermann%2Fpygments-markdown-lexer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jhermann","download_url":"https://codeload.github.com/jhermann/pygments-markdown-lexer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249795203,"owners_count":21326777,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","pygments-lexer","syntax-highlighting"],"created_at":"2024-10-01T19:44:24.231Z","updated_at":"2025-04-19T20:40:58.630Z","avatar_url":"https://github.com/jhermann.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pygments-markdown-lexer\n\nA [Markdown](https://daringfireball.net/projects/markdown/syntax) lexer\nfor [Pygments](http://pygments.org/) to highlight Markdown code snippets.\n\n [![Travis CI](https://api.travis-ci.org/jhermann/pygments-markdown-lexer.svg)](https://travis-ci.org/jhermann/pygments-markdown-lexer)\n [![Coveralls](https://img.shields.io/coveralls/jhermann/pygments-markdown-lexer.svg)](https://coveralls.io/r/jhermann/pygments-markdown-lexer)\n [![GitHub Issues](https://img.shields.io/github/issues/jhermann/pygments-markdown-lexer.svg)](https://github.com/jhermann/pygments-markdown-lexer/issues)\n [![License](https://img.shields.io/pypi/l/pygments-markdown-lexer.svg)](https://github.com/jhermann/pygments-markdown-lexer/blob/master/LICENSE)\n [![Development Status](https://img.shields.io/pypi/status/pygments-markdown-lexer.svg)](https://pypi.python.org/pypi/pygments-markdown-lexer/)\n [![Latest Version](https://img.shields.io/pypi/v/pygments-markdown-lexer.svg)](https://pypi.python.org/pypi/pygments-markdown-lexer/)\n\n\n## Installation\n\n*Pygments Markdown Lexer* can be installed via ``pip install pygments-markdown-lexer`` as usual,\nsee [releases](https://github.com/jhermann/pygments-markdown-lexer/releases) for an overview of available versions.\nTo get a bleeding-edge version from source, use these commands:\n\n```sh\nrepo=\"jhermann/pygments-markdown-lexer\"\npip install -r \"https://raw.githubusercontent.com/$repo/master/requirements.txt\"\npip install -UI -e \"git+https://github.com/$repo.git#egg=${repo#*/}\"\n```\n\nSee [Contributing](#contributing) on how to create a full development environment.\n\n\n## Usage\n\nOnce installed, usually into a virtualenv, the ``pygments_markdown_lexer`` package\nis instantly visible to *Pygments*, since it defines a *Setuptools* entry point\nfor registration.\n\nIn order for *Sphinx* to load and recognize the custom lexer, add the\n``pygments_markdown_lexer`` package name to the ``extensions`` list in ``conf.py``.\nThen use it in a ``code-block`` as if it were a built-in, like this:\n\n    .. code-block:: md\n\n        Enables _Pygments_ to handle\n        [Markdown](https://daringfireball.net/projects/markdown/syntax)\n        in *Sphinx* **code blocks**.\n\nBoth ``md`` and ``markdown`` are valid to specify the language for the code block.\n\n\n## Contributing\n\nTo create a working directory for this project, call these commands:\n\n```sh\ngit clone \"https://github.com/jhermann/pygments-markdown-lexer.git\"\ncd \"pygments-markdown-lexer\"\n. .env --yes --develop\ninvoke build --docs test check\n```\n\nContributing to this project is easy, and reporting an issue or\nadding to the documentation also improves things for every user.\nYou don’t need to be a developer to contribute.\nSee [CONTRIBUTING](https://github.com/jhermann/pygments-markdown-lexer/blob/master/CONTRIBUTING.md) for more.\n\n\n## References\n\n**Specs**\n\n* [Markdown Syntax](https://daringfireball.net/projects/markdown/syntax#p)\n* [Pygments Lexer](http://pygments.org/docs/lexerdevelopment/)\n* [Pygments Tokens](http://pygments.org/docs/tokens/)\n* [Pygments Styles](http://pygments.org/docs/styles/)\n  * [Style Gallery](https://help.farbox.com/pygments.html)\n* [Python Regex](https://docs.python.org/2/library/re.html)\n\n**Tools**\n\n* [Sphinx](http://sphinx-doc.org/)\n* [Pygments](http://pygments.org/)\n* [Cookiecutter](http://cookiecutter.readthedocs.io/en/latest/)\n* [PyInvoke](http://www.pyinvoke.org/)\n* [pytest](http://pytest.org/latest/contents.html)\n* [tox](https://tox.readthedocs.io/en/latest/)\n* [Pylint](http://docs.pylint.org/)\n* [twine](https://github.com/pypa/twine#twine)\n* [bpython](http://docs.bpython-interpreter.org/)\n* [yolk3k](https://github.com/myint/yolk#yolk)\n\n**Packages**\n\n* [Rituals](https://jhermann.github.io/rituals)\n\n\n## Acknowledgements\n\n* Based in part on the ``pygments.lexers.markup`` lexers (*Georg Brandl* and others, BSD-licensed).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhermann%2Fpygments-markdown-lexer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjhermann%2Fpygments-markdown-lexer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjhermann%2Fpygments-markdown-lexer/lists"}