Open Typora Quickly

A simple VS Code extension that adds a button to quickly open markdown files in Typora directly from the editor.

Features

• One-click Typora opening: Click the external link icon in the markdown editor title bar to instantly open the current file in Typora.
• Cross-platform support: Works on Windows, macOS, and Linux with automatic platform detection.
• Context menu support: Right-click on markdown files and select "Open in Typora" from the context menu.
• Command palette integration: Find and execute "Open in Typora" from the command palette.
• Smart activation: Only shows the button when editing markdown files.
• Error handling: Provides helpful guidance if Typora is not installed or not in system PATH.
• Modern VS Code compatibility: Optimized for VS Code ^1.75.0 with automatic activation event generation.

How to Use

1. Open any markdown file in VS Code
2. Use one of the options below:
   • Editor title button: Click the external link icon in the editor title bar
   • Command palette: Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) and type "Open in Typora"
   • Context menu: Right-click in the editor and select "Open in Typora"
3. The current markdown file will open in Typora

Requirements

• Typora must be installed on your system and accessible in the system PATH
• VS Code version 1.75.0 or higher

Typora Installation

If you don't have Typora installed:

1. Download from the official website: typora.io
2. Install it following the instructions for your platform
3. Ensure it's in your system PATH:
   • Windows: During installation, check "Add to PATH" option
   • macOS: Open Typora → Menu → Typora → Install CLI Tool
   • Linux: The installation should automatically add typora to PATH

Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X or Cmd+Shift+X)
3. Search for "Open Typora Quickly"
4. Click Install

From VSIX File

1. Download the .vsix file from the latest release
2. Open VS Code
3. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
4. Type "Extensions: Install from VSIX"
5. Select the downloaded .vsix file

From Source

1. Clone this repository
2. Run pnpm install
3. Run pnpm run compile
4. Press F5 to open the extension in development mode

git clone https://github.com/kazoottt/open-typora-quickly.git
cd open-typora-quickly
pnpm install
pnpm run compile
# Then press F5 in VS Code to test

Configuration

The extension works out of the box, but if Typora is not in your system PATH:

1. Open VS Code settings
2. Search for "Open Typora Quickly"
3. Configure the "Typora Path" setting with the full path to your Typora executable:
   • Windows: C:\Program Files\Typora\Typora.exe
   • macOS: /Applications/Typora.app
   • Linux: /usr/bin/typora

Troubleshooting

"Typora not found" Error

If you see this error:

1. Check if Typora is installed and accessible from your terminal:

   • Windows: Open Command Prompt and type typora --version
   • macOS/Linux: Open Terminal and type typora --version

2. If Typora is not in PATH, configure the path in VS Code settings as described above

3. Reinstall Typora with PATH option enabled (Windows) or install CLI tool (macOS)

Button doesn't appear in editor title bar

1. Make sure you're editing a markdown file (.md extension)
2. Check that the extension is enabled in VS Code (Extensions → search for "Open Typora Quickly")
3. Restart VS Code after installing the extension
4. Try using the Command Palette (Ctrl+Shift+P) to access the command directly

Development

To contribute or modify this extension:

git clone https://github.com/kazoottt/open-typora-quickly.git
cd open-typora-quickly
pnpm install
pnpm run compile
# Then press F5 in VS Code to test in a new Extension Development Host window

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Changelog

0.0.1

• Initial release with Typora integration
• Cross-platform support (Windows, macOS, Linux)
• Editor title button, keyboard shortcuts, context menu, and command palette integration
• Smart activation for markdown files only
• Error handling and configuration support

Enjoy opening markdown files in Typora effortlessly!