https://github.com/linux-china/markdown-chatgpt
Talk to ChatGPT from Markdown
https://github.com/linux-china/markdown-chatgpt
Last synced: about 1 year ago
JSON representation
Talk to ChatGPT from Markdown
- Host: GitHub
- URL: https://github.com/linux-china/markdown-chatgpt
- Owner: linux-china
- Created: 2023-05-03T05:47:45.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-13T16:22:20.000Z (over 1 year ago)
- Last Synced: 2025-04-02T02:51:12.340Z (over 1 year ago)
- Language: Kotlin
- Homepage: https://plugins.jetbrains.com/plugin/21671-chatgpt-with-markdown
- Size: 2.52 MB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
ChatGPT with Markdown
======================
ChatGPT with Markdown is a JetBrains IDE plugin to help you talk with ChatGPT from Markdown file.
# Get started
* Install plugin from IDE plugin manager
or [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/21671-chatgpt-with-markdown)
* Create a file with `.gpt` extension, such as `demo.gpt`
* Copy following code and paste in `demo.gpt` file, and change `openai_api_key` to your own key.
~~~markdown
---
openai_api_key: xxxx
---
# Explain Java
What's Java?
# Generation JUnit 5 unit test
Please give me an example of JUnit 5 unit test.
~~~
* Click run button in the gutter to run ChatGPT query.
# Features
### ChatGPT Markdown format
### Talk with ChatGPT from Markdown.
### Editor split support: one for prompt, another for response.
### `system` and `assistant` messages support, please add `{.system}` or `{.assistant}` after paragraph.
~~~markdown
# Generation unit test
You are a Java programmer, and you are developing a Spring Boot application.
The tech stack is Java 17, Spring Boot 3.0, JUnit 5 , Spring Boot Test, AssertJ etc. {.system}
Please write unit test with Spring Boot Test for the below code:
```java
package org.mvnsearch.service;
import org.springframework.stereotype.Component;
@Component
public class UserService {
public User findNickById(long id) {
return "Jackie";
}
}
```
~~~
### GPT functions support
Please add code fence with `json {.functions}`.
~~~markdown
# Simple Java Example
Give me a simple Java example, and compile the generated source code.
```json {.functions}
[
{
"name": "compile_java",
"description": "Compile Java source file or source code",
"parameters": {
"type": "object",
"properties": {
"source": {
"type": "string",
"description": "java file name or source code"
}
},
"required": [
"source"
]
}
}
]
```
~~~
ChatGPT with Markdown is a JetBrains IDE plugin to help you talk with ChatGPT from Markdown file.
# Get started
Create a file with `.gpt` extension, such as `demo.gpt`. Copy following code and paste in `demo.gpt` file,
and change `openai_api_key` to your own key. Click run button in the gutter to run ChatGPT query.
```markdown
---
openai_api_key: xxxx
---
# Explain Java
What's Java language?
# Explain Kotlin
What's Kotlin language?
```
# Features:
* Standard Markdown format for ChatGPT: h1 is query name, and paragraph is query prompt.
* Make a talk from Markdown: Click run button in the gutter to run ChatGPT query.
* GPT functions support with JSON Schema completion
* OpenAI API Key load: `openai_api_key` in markdown front matter, `OPENAI_API_KEY` in `.env`, `openai.api.key`
in `.env.properties`, `OPENAI_API_KEY` environment variable
* Editor split support: one for prompt, another for response
## Installation
- Using IDE built-in plugin system:
Settings/Preferences > Plugins > Marketplace > Search for "ChatGPT with Markdown" >
Install Plugin
- Manually:
Download the [latest release](https://github.com/linux-china/markdown-chatgpt/releases/latest) and install it manually
using
Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...