mintlify / writer

✍️ AI powered documentation writer
https://www.mintlify.com/writer
MIT License
2.78k stars 129 forks source link

[Tutorial] Use writer on latest Jetbrains #98

Open HookWoods opened 1 year ago

HookWoods commented 1 year ago

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

JinChengneng commented 1 year ago

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

rbouma commented 1 year ago

@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.

oskhel commented 1 year ago

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.

nitatemic commented 1 year ago

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

cokolwiekpl commented 1 year ago

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

shizeying commented 1 year ago

go to releases

alvaro-rrdt commented 1 year ago

go to releases

thanks this works