{"id":22070241,"url":"https://github.com/dginev/latexml-plugin-latexmls","last_synced_at":"2025-07-24T08:35:45.477Z","repository":{"id":56837667,"uuid":"15009001","full_name":"dginev/LaTeXML-Plugin-latexmls","owner":"dginev","description":"A socket server for daemonized LaTeXML processing","archived":false,"fork":false,"pushed_at":"2024-03-20T13:21:16.000Z","size":47,"stargazers_count":3,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-19T11:42:50.359Z","etag":null,"topics":["daemon","latexml","socket-server"],"latest_commit_sha":null,"homepage":null,"language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dginev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-12-07T16:43:31.000Z","updated_at":"2024-02-20T07:16:44.000Z","dependencies_parsed_at":"2022-09-10T01:10:45.936Z","dependency_job_id":null,"html_url":"https://github.com/dginev/LaTeXML-Plugin-latexmls","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/dginev/LaTeXML-Plugin-latexmls","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dginev%2FLaTeXML-Plugin-latexmls","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dginev%2FLaTeXML-Plugin-latexmls/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dginev%2FLaTeXML-Plugin-latexmls/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dginev%2FLaTeXML-Plugin-latexmls/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dginev","download_url":"https://codeload.github.com/dginev/LaTeXML-Plugin-latexmls/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dginev%2FLaTeXML-Plugin-latexmls/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266815221,"owners_count":23988563,"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","status":"online","status_checked_at":"2025-07-24T02:00:09.469Z","response_time":99,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["daemon","latexml","socket-server"],"created_at":"2024-11-30T20:15:42.314Z","updated_at":"2025-07-24T08:35:44.887Z","avatar_url":"https://github.com/dginev.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# LaTeXML::Plugin::latexmls\n\n[![Build Status](https://github.com/dginev/LaTeXML-Plugin-latexmls/workflows/CI/badge.svg)](https://github.com/dginev/LaTeXML-Plugin-latexmls/actions?query=workflow%3ACI)\n[![license](http://img.shields.io/badge/license-Unlicense-blue.svg)](https://raw.githubusercontent.com/dginev/LaTeXML-Plugin-latexmls/master/LICENSE)\n[![CPAN version](https://badge.fury.io/pl/LaTeXML-Plugin-latexmls.svg)](https://badge.fury.io/pl/LaTeXML-Plugin-latexmls)\n\nA minimal socket server for daemonized LaTeXML processing\n\n## Installation\n\nJust another Perl module. Use either the modern `cpanm .` or the classic:\n\n```bash\nperl Makefile.PL ; make ; make test; sudo make install\n```\n\nMake sure that LaTeXML has been installed prior to installing this Plugin, as well as all modules reported missing by Makefile.PL.\n\n## Example use\n\nSee the casual author use pattern by the [latexmlc](https://github.com/brucemiller/LaTeXML/blob/master/bin/latexmlc#L123) executable of LaTeXML.\n\nOn a generic level, `latexmls` takes an HTTP request and returns a JSON payload. This can be illustrated with a minimal curl example:\n\n1. Start a server process on some available port, and specify the allowed inactivity before it automatically shuts down.\n\n    ```bash\n    latexmls --port=43434 --expire=60\n    ```\n\n2. Initialize a new cached conversion profile, using the `cache_key` capability with a mock conversion call. Specify all configuration you would typically provide for latexml/latexmlpost here.\n\n    ```bash\n    curl http://localhost:43434 -o payload.json -d \\\n    'cache_key=eg\u0026preload=article.cls\u0026preload=texvc.sty\u0026whatsin=math\u0026whatsout=math\u0026format=html5\u0026source=literal:1'\n    ```\n\n3. Use the cached profile for real conversions.\n\n    ```bash\n    curl http://localhost:43434 -o payload.json -d 'cache_key=eg\u0026source=literal:\\sqrt{x}\u003e0'\n    ```\n\n    Note that latexmls expects proper [url encoding](https://en.wikipedia.org/wiki/Percent-encoding) if you're assembling your HTTP requests by hand, e.g. `\\sqrt{x}` needs to be transmitted as `%5Csqrt%7Bx%7D`. This is done automatically by the curl `-d` flag in the example above.\n\n4. The returned json payload (indented for readability here) for this configuration should look along the lines of:\n\n    ```json\n    {\n      \"status\": \"No obvious problems\",\n      \"log\": \"...Status:conversion: 0 \",\n      \"status_code\": 0,\n      \"result\": \"\u003cmath ...\u003c/math\u003e\"\n    }\n    ```\n\n## Known current uses of latexmls\n\n* [Authorea](https://www.authorea.com/) via the [latexml-ruby](https://github.com/Authorea/latexml-ruby/) wrapper, since 2017\n* [latexml-runner](https://github.com/dginev/latexml-runner), a local harness for converting large collections, since 2021. Also offers a generic Rust wrapper.\n\n## Alternatives\n\nSee also the [ltxmojo](https://github.com/dginev/LaTeXML-Plugin-ltxmojo/) web showcase which uses a proper web service framework, as a potential alternative or inspiration for bundling LaTeXML into your web framework of choice.\n\n\n### Security Warning\n\nWhile latexmls has been used in production settings, it is not secure standalone. At a minimum, known vulnerabilities in TeX-related I/O should be patched, e.g. using the [secureio](https://github.com/dginev/LaTeXML-Plugin-secureio/) plugin for latexml.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdginev%2Flatexml-plugin-latexmls","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdginev%2Flatexml-plugin-latexmls","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdginev%2Flatexml-plugin-latexmls/lists"}