SimpleJupyterViewer for IntelliJ IDEA

DISCLAIMER: This code was made by Geologist-programmer mostly with SourceCraft and GigaCode generation. Manual changes should be made with caution.

This plugin enables viewing Jupyter notebooks (.ipynb) directly in IntelliJ IDEA.

Features

• View Jupyter notebooks in a formatted HTML view
• Syntax highlighting for code cells
• Proper rendering of Markdown cells
• Cell type identification
• Integration with IntelliJ IDEA’s file system

Requirements

• IntelliJ IDEA 2024.3 or later
• Java 21
• Gradle 9.2.1

Compatibility

This plugin is compatible with:

• IntelliJ IDEA Community and Ultimate Editions
• Other JetBrains IDEs based on the IntelliJ Platform (OpenIDE)
  • PyCharm
  • WebStorm
  • PhpStorm
  • RubyMine
  • GoLand
  • etc.

Installation

Prerequisites

Before building the plugin, ensure you have the following installed:

1. Java 21: Download and install Java 21 from Oracle’s website or use OpenJDK.

2. Gradle 9.2.1: Download and install Gradle from the official Gradle website.

Method 1: Build from source

1. Clone this repository
2. Open the project in IntelliJ IDEA
3. Build the plugin using Gradle

Method 2: Download pre-built plugin (will be available sometime)

1. Go to the Releases page
2. Download the latest .zip file
3. Install it in IntelliJ IDEA via Settings > Plugins > Install Plugin from Disk

Building the Plugin

Using Gradle (recommended)

# Build the plugin distribution (creates a ZIP file)
./gradlew buildPlugin

# Build the project (compiles code and runs tests)
./gradlew build

# Build and run in a development instance of IntelliJ IDEA
./gradlew runIde

# Clean the build
./gradlew clean

Understanding Gradle Commands

There are two main Gradle commands used in this project:

• ./gradlew build: Compiles the source code, runs tests, and creates the necessary build artifacts. This is used primarily for development and testing.

• ./gradlew buildPlugin: Creates a distributable ZIP file of the plugin that can be installed in IntelliJ IDEA. This is the command you should use when creating a plugin for distribution.

For most development work, you’ll use ./gradlew build to compile and test your changes. When you’re ready to create a plugin for installation, use ./gradlew buildPlugin.

Using provided scripts

Windows (CMD)

build.cmd
run.cmd
clean.cmd

Linux/Mac (Bash)

./build.sh
./run.sh
./clean.sh

The built plugin will be located in build/distributions/ directory.

Usage

1. Open a Jupyter notebook (.ipynb) file in IntelliJ IDEA
2. Right-click on the file and select “View as Jupyter Notebook”
3. Or simply open the file to see its structure

Development

Project Structure

src/
├── main/
│   ├── java/              # Java source code
│   └── resources/         # Resources (icons, configuration)
└── test/
    └── java/              # Unit tests

Configuration

The plugin is configured in src/main/resources/META-INF/plugin.xml.

Dependencies

Dependencies are managed via Gradle in build.gradle:

dependencies {
    implementation 'org.json:json:20230227'
    testImplementation 'junit:junit:4.13.2'
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development

Project Structure

src/
├── main/
│   ├── java/              # Java source code
│   └── resources/         # Resources (icons, configuration)
└── test/
    └── java/              # Unit tests

Configuration

The plugin is configured in src/main/resources/META-INF/plugin.xml.

Dependencies

Dependencies are managed via Gradle in build.gradle:

dependencies {
    implementation 'org.json:json:20230227'
    testImplementation 'junit:junit:4.13.2'
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the APACHE 2.0 License - see the LICENSE file for details.