{ "info": { "author": "Peter Zagubisalo", "author_email": "peter.zagubisalo@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Build Tools" ], "description": "# SugarTeX\n\nSugarTeX is a more readable LaTeX language extension and transcompiler to LaTeX. Designed to be used instead of `$formula$` insertions to markdown. \n\nSee [SugarTeX documentation](https://github.com/kiwi0fruit/sugartex/blob/master/sugartex.md). Examples of input to output conversion see in [this PDF](https://github.com/kiwi0fruit/sugartex/blob/master/examples/examples.pdf?raw=true).\n\nI use Markdown with Python code blocks for document programming via [Pandoctools](https://github.com/kiwi0fruit/pandoctools) (like R-Markdown).\n\nBoth Python and Markdown are very readable languages. Unfortunately LaTeX is not like this. So I wrote SugaTeX extension+transpiler that is highly readable. In order to achieve this it heavily uses Unicode so that SugarTeX install instructions even have recommended monospace font fallback chains. And more: [SugarTeX Completions](#sugartex-completions-for-atom) Atom package helps write all that Unicode in a moment.\n\nI am trying to incorporate LaTeX into .md using the Markdown Philosophy of \u201cyou should write something that's readable as plain text, without compilation, also\u201d.\n\n\n## Install\n\nInstall as part of [Pandoctools](https://github.com/kiwi0fruit/pandoctools) - convenient interface and works out of the box.\n\nVia conda:\n\n```bash\nconda install -c defaults -c conda-forge sugartex\n```\n\nVia pip:\n\n```bash\npip install sugartex\n```\n\n\n### Atom editor with full Unicode support\n\nHighly recommended to install [Atom editor](https://atom.io/) as it's the best for markdown.\n\nAtom is perfect for Unicode rich texts. But you need to install some fonts first. Recommended font fallback chains:\n\n* For **Consolas**: `Consolas, 'STI0 Two Mat0 monospacified for Consola0', 'DejaVu Sans Mono monospacified for Consolas', 'Symbola monospacified for Consolas', 'Noto Sans CJK TC', monospace`. Download:\n * Consolas can be installed together with [Microsoft PowerPoint Viewer](https://www.microsoft.com/en-us/download/details.aspx?id=13) till April, 2018. SHA256: 249473568EBA7A1E4F95498ACBA594E0F42E6581ADD4DEAD70C1DFB908A09423. But note that it's license says that \"You may use the software only to view and print files created with Microsoft Office software. You may not use the software for any other purpose.\" so you might not be even allowed to print Consolas font text via Chrome browser,\n * [STI0 Two Mat0 monospacified for Consola0](https://github.com/kiwi0fruit/open-fonts/blob/master/Fonts/STI0TwoMat0_monospacified_for_Consola0.ttf?raw=true) (STIX Two Math for Consolas),\n * [DejaVu Sans Mono monospacified for Consolas](https://github.com/kiwi0fruit/open-fonts/blob/master/Fonts/DejaVuSansMono_monospacified_for_Consolas.ttf?raw=true)\n * [Symbola monospacified for Consolas](https://github.com/kiwi0fruit/monospacifier/blob/d8beda67289bab66244ab0bd64f69bd4933e992c/fonts/Symbola_monospacified_for_Consolas.ttf?raw=true),\n* For **Roboto Mono**: `'Open Mono', 'Noto Sans Mono', 'IBM Plex Mono', 'STI0 Two Mat0 monospacified for Robot0 Mono', 'DejaVu Sans Mono', 'Symbola monospacified for DejaVu Sans Mono', 'Noto Sans CJK TC', monospace`. Download:\n * [Open Mono](https://github.com/kiwi0fruit/open-fonts/blob/master/Fonts/OpenMono.7z?raw=true) that is simply a renamed monospacified version of Roboto Mono (italic in Roboto Mono has different width than regular),\n * [Noto Sans Mono](https://github.com/kiwi0fruit/open-fonts/blob/master/Fonts/NotoSansMono-hinted.7z?raw=true),\n * [IBM Plex Mono](https://fonts.google.com/specimen/IBM+Plex+Mono). [Download](https://fonts.google.com/specimen/IBM+Plex+Mono), [Download](https://github.com/google/fonts/tree/master/ofl/ibmplexmono),\n * [STI0 Two Mat0 monospacified for Robot0 Mono](https://github.com/kiwi0fruit/open-fonts/blob/master/Fonts/STI0TwoMat0_monospacified_for_Robot0Mono.ttf?raw=true) (STIX Two Math for Roboto Mono),\n * [DejaVu Sans Mono](https://dejavu-fonts.github.io/Download.html),\n * [Symbola monospacified for DejaVu Sans Mono](https://github.com/cpitclaudel/monospacifier/blob/master/fonts/Symbola_monospacified_for_DejaVuSansMono.ttf?raw=true),\n\n[Noto fonts](https://www.google.com/get/noto/) can also be freely downloaded (if you need CJK support). TC is Traditional Chinese but it can also be SC, JP, KR. I used monospacified fonts with the help of [monospacifier.py](https://github.com/cpitclaudel/monospacifier). If you do not like Consolas/Roboto Mono you can pick there monospacified versions for other monospace fonts.\n\n\n### SugarTeX Completions for Atom\n\nInstall [SugarTeX Completions](https://atom.io/packages/sugartex-completions) package for easy typing SugarTeX and lots of other Unicode characters. (it's incompatible with [latex-completions](https://atom.io/packages/latex-completions) package).\n\nIn the [SugarTeX documentation](https://github.com/kiwi0fruit/sugartex/blob/master/sugartex.md) appropriate shortcuts for SugarTeX Completions for Atom are given.\n\n\n## Usage examples\n\nExample of input to output conversion is at the end of [this PDF].\n\nWindows:\n\n```bat\nchcp 65001 > NUL\nset PYTHONIOENCODING=utf-8\n\ntype doc.md | ^\npre-sugartex | ^\npandoc -f markdown --filter sugartex -o doc.md.md\n```\n\nUnix:\n\n```sh\nexport PYTHONIOENCODING=utf-8\n\ncat doc.md | \\\npre-sugartex | \\\npandoc -f markdown --filter sugartex -o doc.md.md\n```\n\nOr splitting Pandoc reader-writer:\n\n```sh\nexport PYTHONIOENCODING=utf-8\n\ncat doc.md | \\\npre-sugartex | \\\npandoc -f markdown -t json | \\\nsugartex --kiwi | \\\npandoc -f json -o doc.md.md\n```\n\n[Panflute](https://github.com/sergiocorreia/panflute) scripts are also installed so you can use it in default Panflute [automation interface in metadata](http://scorreia.com/software/panflute/guide.html#running-filters-automatically) or in recommend [panfl](https://github.com/kiwi0fruit/pandoctools/blob/master/docs/panfl.md) CLI:\n\n* `panfl sugartex --to markdown`,\n* `panfl sugartex.kiwi -t markdown`.", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/kiwi0fruit/sugartex", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sugartex", "package_url": "https://pypi.org/project/sugartex/", "platform": "", "project_url": "https://pypi.org/project/sugartex/", "project_urls": { "Homepage": "https://github.com/kiwi0fruit/sugartex" }, "release_url": "https://pypi.org/project/sugartex/0.1.16/", "requires_dist": null, "requires_python": ">=3.6", "summary": "More readable LaTeX language extension and transcompiler to LaTeX", "version": "0.1.16" }, "last_serial": 4722942, "releases": { "0.1.13": [ { "comment_text": "", "digests": { "md5": "6ccf61130086fc65eedc389671cea714", "sha256": "2810163283ba6b9f6d53aaf1eefa5265be46c3ccbd261abd08c7cc5d5d5101fa" }, "downloads": -1, "filename": "sugartex-0.1.13.tar.gz", "has_sig": false, "md5_digest": "6ccf61130086fc65eedc389671cea714", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 33202, "upload_time": "2018-12-25T09:18:43", "url": "https://files.pythonhosted.org/packages/7f/69/c342a809c85ab2529f335d0e88b9d4de9f58acf1a138b8b111380e8d79c0/sugartex-0.1.13.tar.gz" } ], "0.1.14": [ { "comment_text": "", "digests": { "md5": "935aff63dc54ace7a9804b800017a374", "sha256": "b0c770a405a407e9667936480d7fd36b7ae4b8fd980c9eb0d8265b805e243d2c" }, "downloads": -1, "filename": "sugartex-0.1.14.tar.gz", "has_sig": false, "md5_digest": "935aff63dc54ace7a9804b800017a374", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 33115, "upload_time": "2019-01-21T18:33:50", "url": "https://files.pythonhosted.org/packages/e9/ca/6a96b10114f54f68ed1ba3c7fe497145760d7078a2d96236116b63686702/sugartex-0.1.14.tar.gz" } ], "0.1.15": [ { "comment_text": "", "digests": { "md5": "be008c2d331195fb8d01aa8f9d5312bb", "sha256": "42c203ac72e974ebadcf388187e541c0f295c8ee64bc8b2410bf5ea2a7d9fd00" }, "downloads": -1, "filename": "sugartex-0.1.15.tar.gz", "has_sig": false, "md5_digest": "be008c2d331195fb8d01aa8f9d5312bb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 33119, "upload_time": "2019-01-21T18:47:30", "url": "https://files.pythonhosted.org/packages/c6/67/91a601599fdc659c66c12924eedec057b0fe0f14d269efb9b62167a37b56/sugartex-0.1.15.tar.gz" } ], "0.1.16": [ { "comment_text": "", "digests": { "md5": "aef92aab6d63d345159c60d5a7f0868b", "sha256": "e14ffbef643b34d6d4cb0de5b57d55e58f16a9afbe7e18e99ab4e33a4f92dd30" }, "downloads": -1, "filename": "sugartex-0.1.16.tar.gz", "has_sig": false, "md5_digest": "aef92aab6d63d345159c60d5a7f0868b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 33152, "upload_time": "2019-01-21T19:37:22", "url": "https://files.pythonhosted.org/packages/e1/bb/694292d858157bea53fc46cc85c9b5df8c00031999239c6a92bc6ba5485c/sugartex-0.1.16.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aef92aab6d63d345159c60d5a7f0868b", "sha256": "e14ffbef643b34d6d4cb0de5b57d55e58f16a9afbe7e18e99ab4e33a4f92dd30" }, "downloads": -1, "filename": "sugartex-0.1.16.tar.gz", "has_sig": false, "md5_digest": "aef92aab6d63d345159c60d5a7f0868b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 33152, "upload_time": "2019-01-21T19:37:22", "url": "https://files.pythonhosted.org/packages/e1/bb/694292d858157bea53fc46cc85c9b5df8c00031999239c6a92bc6ba5485c/sugartex-0.1.16.tar.gz" } ] }