shuxueshuxue / obsidian-aitex

Obsidian Plugin for faster LaTeX input powered by OpenAI API.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Greetings, Mathemagicians! We present to you AItex, a trusty sidekick on your journey through the maze of mathematical formulae in the land of Obsidian. We've been chatting with the wizards at OpenAI, who gave us a nifty tool called the OpenAI API.

Features

Just like the best magical artifacts, AItex has some cool tricks up its sleeve:

  • A spell of Binding: AItex is tightly bound with Obsidian, ready to aid you at a moment's notice.
  • Whispering to Spirits: The core of AItex's magic is the OpenAI API, a mystical entity we converse with to understand your numerical notations.

Installation

Before you summon AItex, ensure your Obsidian grimoire is of v1.3.0 or a newer edition.

Now, hold onto your hats because AItex isn't just sitting around in the Obsidian market. You'll need to conjure it up manually, and don't forget to obtain an OpenAI API key – it's our magic phrase to call upon the OpenAI spirits.

Usage

Harness the power of AItex's spellbinding features! Note, each magical command only applies to the line where your caret currently resides. Now, let's conjure up some magic:

  • With a swift double backslash (\\) then press enter: Invoke AItex to cast a spell that restructures the math puzzle on your current line.
  • With a powerful triple backslash (\\\) then press enter: AItex uses a more potent charm, useful for grand challenges like the daunting 3x3 matrix.
  • With a commanding quadruple backslash (\\\\) then press enter: AItex summons the wisdom of GPT-4, a powerful force ready to breathe life into your text and sculpt even the most elaborate mathematical marvels into coherent forms.
  • When your caret's current line is empty, AItex will not rest. Instead, it will journey upwards, line by line, gathering up to 10 consecutive non-empty lines (or until it encounters an empty line as a signal to stop) to weave its magic on. This gathered block of lines will then be considered as a whole and formatted in a single swoop. This feature allows AItex to understand and format more complex mathematical constructions that span multiple lines.

Contributing

Fellow wizards and witches, we welcome your magical insights! If you have enhancements or improvements, please clone our spellbook (i.e., fork the repository), make your mystical modifications, and submit a scroll with your changes (pull request).

Contact

If you need a magical consultation or have ideas to share, send us an owl! We're always eager to hear from fellow enchanters.

Acknowledgments

We tip our hats to the arcane masters at OpenAI. Without their mystic API, AItex would be just another ordinary wand.

About

Obsidian Plugin for faster LaTeX input powered by OpenAI API.


Languages

Language:TypeScript 86.7%Language:JavaScript 12.0%Language:CSS 1.2%