TeXShift

KO | EN

gitlite — search

#hacktoberfest #llm #golang #go #machine-learning #rust #linux #macos #nodejs #windows #awesome #pytorch #security #open-source

(★ 16)

A OneNote COM add-in for seamless, bi-directional conversion between rich text and plain text formats like Markdown, LaTeX, and Mermaid.

TeXShift Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# TeXShift: Bridging OneNote and Plain Text

English | [简体中文](README.zh-CN.md)

**TeXShift** is a COM Add-in for Microsoft OneNote designed to address the core pain points that engineers, researchers, and students face when taking technical notes in OneNote: **building a bridge between a powerful rich text editor and efficient plain text markup languages like Markdown and LaTeX.**

---

## Features

- **Markdown Conversion** - Convert Markdown syntax to OneNote rich text
  - Headings (H1-H6)
  - Ordered/unordered lists
  - Task lists (checkboxes)
  - Block quotes (nested support)
  - Tables (header bold, column alignment)
  - Links
  - Embedded images
  - Horizontal rules (image or character style)

- **LaTeX Formulas** - Convert LaTeX math expressions to native editable OneNote equations
  - Built-in MathJax resources for fully offline operation
  - Inline (`$...$`) and display (`$$...$$`) math support

- **Mermaid Diagrams** - Render Mermaid diagrams as embedded PNG images
  - Flowcharts, sequence diagrams, class diagrams, and more
  - Configurable theme and resolution

- **Syntax Highlighting** - TextMateSharp-based code highlighting
  - Wide language support with accurate tokenization
  - Customizable background color, text color, font, and spacing

- **Intelligent Selection** - Two operation modes
  - **Cursor Mode**: Operates on the entire text box
  - **Selection Mode**: Operates on complete paragraphs containing highlighted text

- **Custom Styles** - Full control over appearance via settings UI
  - Quote block background color
  - Heading font sizes (H1-H6)
  - Code block styling (colors, font, size, line spacing)
  - Inline code styling
  - Mermaid theme and max resolution
  - Horizontal rule style (image/character)

- **Reverse Conversion** - Convert OneNote rich text back to Markdown
  - Dual-channel strategy: embedded metadata (lossless) + XML parsing (fallback)
  - Headings, paragraphs, lists (ordered/unordered/task), tables
  - Code blocks with syntax highlighting stripped
  - Math formulas (restore original LaTeX via metadata)
  - Mermaid diagrams (restore original source via metadata)
  - Inline styles (bold, italic, strikethrough, highlight, underline, superscript, subscript, code, links)

- **Localization** - UI available in English and Simplified Chinese

- **Fully Offline** - All core features work locally without network connection

### In Development

- Live preview pane

## Tech Stack

- **Language:** C# (.NET Framework 4.8)
- **Framework:** OneNote COM Add-in
- **UI:** WPF with Material Design
- **Dependencies:**
  - Markdig - Markdown parsing
  - TextMateSharp - Syntax highlighting
  - MathJax - LaTeX rendering
  - Mermaid.js - Diagram rendering

## System Requirements

- Windows 10/11
- Microsoft OneNote Desktop (x64)
- .NET Framework 4.8
- WebView2 Runtime (for LaTeX and Mermaid rendering)

## Installation

Download the latest x64 Setup `.exe` from [Releases](https://github.com/Victor-Quqi/TeXShift/releases).

When upgrading from TeXShift 0.2.x or earlier, uninstall the old version first.

The uninstaller installed by the Setup `.exe` can optionally remove the installing user's TeXShift settings, caches, and default-location debug logs.

## Building from Source

For developers who want to build TeXShift from source:

1. **Clone the repository**
   ```bash
   git clone https://github.com/Victor-Quqi/TeXShift.git
   cd TeXShift
   ```

2. **Build and test**

```powershell
   .\build.ps1 -Target Build -Configuration Debug
   .\build.ps1 -Target Test -Configuration Debug
   ```

The build script restores the pinned MathJax package and NuGet dependencies. Visual Studio is optional.

3. **Register the Debug add-in once**

Build normally, close OneNote, then run the following command from an elevated PowerShell:

```powershell
   .\setup\Register-TeXShiftDev.ps1 -Action Register
   ```

Later builds keep the same output path. Restart OneNote to load the newly built DLL. Use `-Action Status` without elevation to inspect the registration, or `-Action Unregister` from an elevated PowerShell to remove the development ribbon.

## License

This project is licensed under [GPLv3](LICENSE).

TeXShift

TeXShift Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

TeXShift

TeXShift Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README