Skip to content
This repository was archived by the owner on Jun 12, 2026. It is now read-only.
This repository was archived by the owner on Jun 12, 2026. It is now read-only.

[Tutorial] Use writer on latest Jetbrains #98

Description

@HookWoods

Here is the tutorial to use mintlify writer on the latest Jetbrains product until the jar get published to JetBrains website:

1- You need at least Java 17 and git on your computer
2- Then git clone this repo: git clone https://github.com/mintlify/writer.git
3- Then type cd IntelliJ
4- Then type ./gradlew clean buildPlugin

5- The plugin will be built for the latest version under build/distributions
CleanShot 2023-01-16 at 13 11 27

6- Open your ide (Webstorm, Intellij, ...)
7- Go to Settings > Plugins > Click on the 3 dots near Installed
CleanShot 2023-01-16 at 13 09 43

8 - Select the zip from instruction 5, restart your ide and it's done!
CleanShot 2023-01-16 at 13 10 47

Activity

  1. JinChengneng commented on Jan 16, 2023

    @JinChengneng

    Hi Hugo @HookWoods, thank you very much for your step-by-step instructions. I'd like to try it right away. Thanks again!

  2. rbouma commented on Jan 18, 2023

    @rbouma

    @HookWoods Thank you very much for this temporarily solution. It was taking too long for Jetbrains to include the new build in the plugin store.

  3. oskhel commented on Jan 25, 2023

    @oskhel

    Hi, thank you for the guide.
    I got the error below at first, but managed to get around it by changing version of kotlin.jvm in intellij/build.gradle.kts

    // Kotlin support
    //id("org.jetbrains.kotlin.jvm") version "1.6.10"
    id("org.jetbrains.kotlin.jvm") version "1.8.0"
    

    The error:

    e: /Users/{user}/www/writer/intellij/src/main/kotlin/com/mintlify/document/services/MyProjectService.kt: (9, 9): Class 'kotlin.Unit' was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.8.0, expected version is 1.6.0.
    The class is loaded from /Users/{user}/.gradle/caches/modules-2/files-2.1/com.jetbrains.intellij.idea/ideaIC/LATEST-EAP-SNAPSHOT/cc032a91ab71245ad3610d01e5eb34d4cee881bc/ideaIC-LATEST-EAP-SNAPSHOT/lib/3rd-party-rt.jar!/kotlin/Unit.class
    e: /Users/{user}/www/writer/intellij/src/main/kotlin/com/mintlify/document/services/MyProjectService.kt: (9, 9): Class 'kotlin.io.ConsoleKt' was compiled with an incompatible version of Kotlin. The binary version of its metadata is 1.8.0, expected version is 1.6.0.
    The class is loaded from /Users/{user}/.gradle/caches/modules-2/files-2.1/com.jetbrains.intellij.idea/ideaIC/LATEST-EAP-SNAPSHOT/cc032a91ab71245ad3610d01e5eb34d4cee881bc/ideaIC-LATEST-EAP-SNAPSHOT/lib/3rd-party-rt.jar!/kotlin/io/ConsoleKt.class

    Task :compileKotlin FAILED

    FAILURE: Build failed with an exception.

  4. nitatemic commented on Feb 18, 2023

    @nitatemic

    Hi, thank you for the guide. I got the error below at first, but managed to get around it by changing version of kotlin.jvm in intellij/build.gradle.kts

    // Kotlin support
    //id("org.jetbrains.kotlin.jvm") version "1.6.10"
    id("org.jetbrains.kotlin.jvm") version "1.8.0"
    

    I made the modification you indicated and managed to make a build that works under Webstorm 2022.3.2. Here is my build.
    Mintlify Doc Writer-1.2.3.zip

  5. cokolwiekpl commented on Feb 24, 2023

    @cokolwiekpl

    Build created by @nitatemic works with IntelliJ IDEA 2022.3.2 also.

  6. ghost pinned this issue on Mar 16, 2023
  7. hexonal commented on Mar 30, 2023

    @hexonal

    go to releases

  8. alvaro-rrdt commented on Apr 9, 2023

    @alvaro-rrdt

    go to releases

    thanks this works

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions