{"id":13450123,"url":"https://github.com/simtex-dev/engine","last_synced_at":"2025-03-23T16:31:00.271Z","repository":{"id":53849921,"uuid":"520186148","full_name":"simtex-dev/engine","owner":"simtex-dev","description":"Convert your files into LaTeX/pdf with one command!","archived":false,"fork":false,"pushed_at":"2022-11-21T03:48:43.000Z","size":15881,"stargazers_count":17,"open_issues_count":17,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-10T15:06:33.052Z","etag":null,"topics":["latex","markdown","pdf","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simtex-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-01T16:35:28.000Z","updated_at":"2023-12-26T12:13:58.000Z","dependencies_parsed_at":"2022-08-13T03:01:06.654Z","dependency_job_id":null,"html_url":"https://github.com/simtex-dev/engine","commit_stats":null,"previous_names":["iaacornus/simtex"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtex-dev%2Fengine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtex-dev%2Fengine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtex-dev%2Fengine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simtex-dev%2Fengine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simtex-dev","download_url":"https://codeload.github.com/simtex-dev/engine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245130708,"owners_count":20565698,"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":["latex","markdown","pdf","python"],"created_at":"2024-07-31T07:00:30.962Z","updated_at":"2025-03-23T16:30:59.020Z","avatar_url":"https://github.com/simtex-dev.png","language":"Python","funding_links":[],"categories":["Simtex","\u003ca name=\"conversion\"\u003e\u003c/a\u003eConversion"],"sub_categories":[],"readme":"# `simtex`\n\n![](https://api.codiga.io/project/34276/score/svg)\n![](https://github.com/iaacornus/simtex/actions/workflows/pytest.yaml/badge.svg)\n![](https://img.shields.io/pypi/v/simtex?label=pypi%20package)\n![](https://img.shields.io/pypi/dm/simtex)\n![](https://img.shields.io/github/license/iaacornus/simtex)\n![](https://badgen.net/pypi/python/simtex)\n\n`simtex` (simplified LaTeX) allows you to convert your mardown or files\ninto PDF using LaTeX with one command, configured with simple `.json` file.\n\n\u003e `simtex` is a program that works based on rules of the user that is\ndefined in `simtex.json`, which the program uses to the files and converts\nit in LaTeX based on the rules defined by the user.\n\n`simtex` also allows for interop between markdown and LaTeX, especially in cases\nwhere markdown is not enough to format the document, that part could be written\nin LaTeX while the others would be converted by `simtex`!\n\n\u003e Note: This program does not intend to replace the LaTeX system, but to\nsimplify the process of turning your already existing markdown/text file\ninto PDF with LaTeX.\n\n\u003e Note: The program currently only supports basic markdown syntax and\nfeatures, and not HTML tags.\n\n# Program Options\n\n```\n❯ simtex --help\nusage: simtex [INPUT] [ARGUMENTS]\n\nConvert your markdown or text files into LaTeX/pdf with one command! Interop\nwith LaTeX and markdown is also allowed by simtex!\n\npositional arguments:\n  [INPUT]               File to convert to LaTeX.\n\noptions:\n  -h, --help            show this help message and exit\n  -b, --build           Build the generated LaTeX file.\n  -B, --buildnview      Build the generated LaTeX file and view the output.\n  -F FONT, --font FONT  Use different font package.\n  -s FONTSIZE, --fontsize FONTSIZE\n                        Use different font size.\n  -p PAPERSIZE, --papersize PAPERSIZE\n                        Use different paper size.\n  -I INDENT, --indent INDENT\n                        Indent size to be used.\n  -m MARGIN, --margin MARGIN\n                        Margin size to be used.\n  -e ENCODING, --encoding ENCODING\n                        Use a different encoding for the document.\n  -t TITLE, --title TITLE\n                        Set the title of the document.\n  -f FILENAME, --filename FILENAME\n                        Use different name for the output file.\n  -o OUTPUTFOLDER, --outputfolder OUTPUTFOLDER\n                        Change the output folder for the output file.\n  -a AUTHOR, --author AUTHOR\n                        Set the author name of the document.\n  -d DATE, --date DATE  Set the date of the document.\n  -c COMPILER, --compiler COMPILER\n                        Use a different LaTeX compiler.\n  -ft, --filenametitle  Use the filename as title.\n  -y, --assumeyes       Assume yes to every prompt.\n  -R, --replace         Automatically replace math symbols defined.\n  -v, --verbose         Show the stdout of processes.\n  --version             Print the version number of the application.\n```\n\n# Convertion features\n\nThe program allows the user to convert simple file such as markdown or text\nfile into PDF using LaTeX. This program does not intend to compete with pandoc,\nwhich essentially does the same but on higher level. Currently, the program\nhas features that can satisfy conversion of basic inputs:\n\n1. Supports the most basic commands, such as **bold**, _italics_,\n**_emphasize_**, `inline code`, quotes, as well as [hyperlinks](hyperlinks).\n2. Environments, the program supports a multiline math environment using\n`align`, single line math equation using `equation` environment, as well as\ncode blocks using `lstlisting` with syntax highlighting.\n3. Figures with captions.\n4. Sections, subsections upto subparagraphs.\n5. Basic document metadata and properties that can be provided in a\nconfiguration file for default value, this includes, author, date, font, among\nothers, view the [short documentation](./examples/config/README.md) for full\nlist.\n6. Simple [config file](./examples/config/simtex.json) using JSON, which\ndefines the rules that should be followed on how the program should parse the\ninput, as well as how to format the document.\n\nRefer to the [PDF](./examples/1/out/hello.pdf) for more details.\n\n# Examples\n\nYou can view the output of the program [here](./examples/1/out/hello.pdf) which was\ngenerated using the command:\n\n```\nsimtex examples/1/hello.md -t \"Hello Simtex!\" -f hello -a iaacornus\" -d \"August 15, 2552\"\n```\n\n\u003e View [`./examples/1/hello.md`](./examples/1/example.md)\n\n\u003e View output: [.examples/1/hello.pdf](./examples/1/out/hello.pdf)\n\nTo convert a LaTeX file, and rename the default author defined in\n`$CONF_PATH/simtex.json`, add `-a=\"iaacornus (or your name)`, and with the\ndate, `-d=\"August 15, 2552` to provide other date instead of the present. The\nprogram will output the `tex` file, as well as `pdf`, if `-b` was used, in `./out`\ninside the folder of the input if there is no output folder given. See the\n[documentation of arguments and configuration file](./examples/config/README.md).\n\n# Program features\n\n1. Convert a whole directory of files into LaTeX. `simtex` allows conversion of\nbunch of files in all at once.\n2. 'simtex' supports different compilers.\n3. Interoperation between LaTeX and raw files. `simtex` is a program\nthat works based on the rules defined by user in `simtex.json`, which it uses\nto convert the document given by the user.\n4. Automatic replacement (**beta**) of unicode characters and ASCII symbols that represent mathematical symbol or anything that is defined by user to their respective LaTeX command or the defined command by the user.\n\n# Installation\n\nStarting `v0.3.2-beta`, there is a released frozen code which can be easily downloaded\nand executed directly with `./simtex [OPTIONS]`:\n\n```\n./simtex --help\n```\n\n\u003e All of the dependency needed is packaged with in this build.\n\nAnother method to install the project is with `pip`. Since the package is\npublished on [PyPI](https://pypi.org/project/simtex/) since v0.2.0-alpha:\n\n```\npip install --user simtex\n```\n\nOther options, specifically `-b` and `-B` requires `pdflatex` and any default\npdf viewer for the latter. The LaTeX compiler can be provided by any of TeX\ndistributions that can be installed, but `texlive` with its full package is\nrecommended since it is tested. `texlive` is available in most distribution\nand can be installed with its package manager:\n\n```\n# fedora\nsudo dnf install texlive-scheme-full\n\n# arch linux\nsudo pacman -S texlive-most\n\n# debian\nsudo apt install texlive\n```\n\nFor other installation method, see [INSTALL.md](INSTALL.md) for details.\n\n# Contribution\n\nRefer to [CONTRIBUTING](CONTRIBUTING.md).\n\n1. All contributions are required to abide by the [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)\n2. Opening and reporting issues is welcomed and considered as valuable contribution in this project.\n\n# Roadmap\n\nThe first prioritized features (not sorted) are listed below:\n\n- [ ] Support for enumerate/lists.\n- [ ] Support Windows\n- [ ] Add templates\n- [ ] Include GUI\n- [ ] Improve table support\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimtex-dev%2Fengine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimtex-dev%2Fengine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimtex-dev%2Fengine/lists"}