Skip to content

QZGao/latex-suite-app

Repository files navigation

LaTeX Suite desktop app icon

LaTeX Suite desktop app package version test workflow badge

Lightweight Windows app for fast LaTeX composition. Built with Electron on top of the LaTeX Suite Core CodeMirror 6 Extension, which is a fork of the popular Obsidian LaTeX Suite.

The experience is essentially the same as below (from Obsidian LaTeX Suite's demo), except that $$ is unneeded:

Obsidian LaTeX Suite Demo

Features

  • Fast LaTeX composition with live preview.
  • Lightweight and portable, no installation required (although an installer is also provided if you prefer).
  • Launchable via a global hotkey (default: Ctrl+.) for quick access from any application.

Three launch modes:

  • Insert: directly insert the formula into the active application at the cursor position.
  • Selection Replace: Ctrl+C the current selection as the formula context, then insert the composed formula back to replace the selection.
  • Auto Selection Replace: Ctrl+A, Ctrl+C to select all and copy as the formula context, then insert the composed formula back to replace the selection.

Usage

Installation

Download the latest installer from the releases page. Either download and run the installer, or download the portable build and run the executable directly.

Setup global hotkey and launch mode

Once the app is running, right-click the system tray icon and select "Settings..." to open the settings window. From there you can set up the global hotkey and launch mode. You can also change the launch mode on the fly by right-clicking the system tray icon and selecting the desired mode from the "Mode" submenu.

Custom snippets

The app supports custom snippets defined in the user-snippets.js file located in the app data directory. You can find the snippet file by right-clicking the system tray icon and select "Settings...", then click the corresponding path link under the "Snippet files" section. The snippet file is an array of rules, where each rule has a trigger, a replacement, and options. The trigger is the string that will be replaced by the replacement when the rule is applied. The options can be used to specify conditions for when the rule should be applied, such as only applying the rule when appending text.

{trigger: "op", replacement: "\\operatorname{$0}$1", options: "tA"},

For detailed documentation on the snippet format and options, see the documentation from Obsidian LaTeX Suite.

Development

Commands

  • corepack pnpm install
  • npm run version:check
  • npm run version:bump -- <version>
  • npm run test
  • npm run build
  • npm run package:desktop:dir
  • npm run dist:desktop:win

Artifacts

  • unpacked app: artifacts/desktop/win-unpacked
  • installer: artifacts/desktop/LaTeX Suite Setup <version>.exe
  • portable build: artifacts/desktop/LaTeX Suite <version>.exe
  • packaged bridge payload: artifacts/win-bridge/win-x64/win-bridge.exe

Credits

This project is based on the work of Obsidian LaTeX Suite, which is developed by artisticat1 and contributors, licensed under the MIT License.

The app icon is designed based on the work of Guy vandegrift under CC0 1.0.

About

Lightweight Windows app for fast LaTeX composition.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors