Skip to content

Commit 4485216

Browse files
committed
Doc
1 parent 810583f commit 4485216

File tree

2 files changed

+122
-61
lines changed

2 files changed

+122
-61
lines changed

README.md

Lines changed: 116 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,50 @@
1-
# leetcode-editor [![Release](https://github.com/shuzijun/leetcode-editor/workflows/Release/badge.svg)](https://github.com/shuzijun/leetcode-editor/releases) [![Snapshot](https://github.com/shuzijun/leetcode-editor/workflows/Snapshot/badge.svg)](https://github.com/shuzijun/leetcode-editor/actions?query=workflow%3ASnapshot)
2-
3-
- [English Document](#Introduction)
4-
- [中文文档](https://github.com/shuzijun/leetcode-editor/blob/master/README_ZH.md)
5-
6-
- Useful Links
7-
- [Login Help](https://github.com/shuzijun/leetcode-editor/blob/master/doc/LoginHelp.md)
8-
- [Custom Code](https://github.com/shuzijun/leetcode-editor/blob/master/doc/CustomCode.md) ([demo](https://github.com/shuzijun/leetcode-question))
9-
1+
# [![Leetcode Editor][plugin-logo]][gh:leetcode-editor] Leetcode Editor
2+
3+
[![Release][badge:release]][gh:releases]
4+
[![Snapshot][badge:snapshot]][gh:snapshot]
5+
[![License][badge:license]][gh:license]
6+
[![Plugin Homepage][badge:plugin-homepage]][plugin-homepage]
7+
[![Version][badge:version]][plugin-versions]
8+
[![Pro Plugin Homepage][badge:plugin-homepage-pro]][plugin-homepage-pro]
9+
[![Version][badge:pro-version]][plugin-versions-pro]
10+
[![Downloads][badge:downloads]][plugin-homepage]
11+
[![English Document][badge:en-doc]][gh:en-doc]
12+
[![中文文档][badge:zh-doc]][gh:zh-doc]
13+
[![捐赠][badge:donate]][shuzijun-donate]
14+
[![内推][badge:referrals]][shuzijun-referrals]
15+
16+
<p align="center"><img src="https://s1.imagehub.cc/images/2022/07/10/leetcode-demo.gif" alt="demo" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
17+
18+
---
19+
1020
## Introduction
11-
Do Leetcode exercises in IDE, support `leetcode.com` and `leetcode.cn`, to meet the basic needs of doing exercises.
12-
Support theoretically: IntelliJ IDEA PhpStorm WebStorm PyCharm RubyMine AppCode CLion GoLand DataGrip Rider MPS Android Studio.
13-
<a href="http://shuzijun.cn/leetcode-editor/monitor.html" target="_blank">be with you!</a>
14-
21+
Do Leetcode exercises in IDE, support `leetcode.com` and `leetcode.cn`, meet the needs of problem solving and debugging.
22+
Support theoretically: **IntelliJ IDEA**,**PhpStorm**,**WebStorm**,**PyCharm**,**RubyMine**,**AppCode**,**CLion**,**GoLand**,**DataGrip**,**Rider MPS**,**Android Studio**.
23+
24+
- [English Document][gh:en-doc]
25+
- [中文文档][gh:zh-doc]
26+
27+
- Useful Links
28+
- [Login Help][gh:login-help]
29+
- [Custom Code][gh:custom-code] ([demo][gh:leetcode-question])
1530

16-
## How to use
17-
<p align="center">
18-
<img src="https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/leetcode-editor-3.0.gif" alt="demo"/>
19-
</p>
31+
## Getting Started
32+
<p align="center"><img src="https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/doc/leetcode-editor-3.0.gif" alt="start" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
33+
2034

2135
## Local debugging
22-
<p align="center">
23-
<img src="https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/customConfig-100.gif" alt="demo"/>
24-
</p>
36+
<p align="center"><img src="https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/doc/customConfig-100.gif" alt="loacl" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
37+
2538

26-
### Installation([help](https://www.jetbrains.com/help/idea/2019.2/managing-plugins.html))
27-
- **Install via plug-in library** [leetcode-editor](https://plugins.jetbrains.com/plugin/12132-leetcode-editor)
28-
- **Install by downloading the file** [releases](https://github.com/shuzijun/leetcode-editor/releases)
29-
- **If you are willing to donate to this project, you can choose the pro version** [leetcode-editor-pro](https://plugins.jetbrains.com/plugin/17166-leetcode-editor-pro)
39+
### Installation([help][managing-plugins])
40+
- **Install via plug-in library** [leetcode-editor][plugin-homepage]
41+
- **Install by downloading the file** [releases][gh:releases]
42+
- **If you are willing to donate to this project, you can choose the pro version** [leetcode-editor-pro][plugin-homepage-pro]
3043

3144
### Configuration (configuration for first installation)
3245

33-
<p align="center">
34-
<img src="https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/config-3.0.png" alt="settings"/>
35-
</p>
46+
<p align="center"><img src="https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/doc/config-3.0.jpg" alt="config" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
47+
3648

3749
- **Configuration path**: `File` -> `settings`->`tools`->`leetcode plugin`
3850
- **`URL options`**: `leetcode.com`OR`leetcode.cn`
@@ -41,36 +53,27 @@
4153
- **`Password`**: Login password
4254
- **`Temp File Path`**: Temporary file storage catalogue
4355
- **`proxy(HTTP Proxy)`**: HTTP Proxy,config path:`File` -> `settings`->`Appearance & Behavior`->`System Settings`->`HTTP Proxy`
44-
- **`Custom code template`**: Custom code template ([details](https://github.com/shuzijun/leetcode-editor/blob/master/doc/CustomCode.md)) ([demo](https://github.com/shuzijun/leetcode-question))
56+
- **`Custom code template`**: Custom code template ([details][gh:custom-code-zh]) ([demo][gh:leetcode-question])
4557
- **`LevelColour`**: Customize the difficulty color of the question, it will take effect after restart
4658

47-
### Window (Icon in the lower right corner of the main window![icon](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/LeetCodeIcon.png))
48-
49-
<p align="center">
50-
<img src="https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/window-3.0.png" alt="window"/>
51-
</p>
59+
### Window (Icon in the lower right corner of the main window![icon][icon:leetcode])
60+
61+
<p align="center"><img src="https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/doc/window-3.0.jpg" alt="window" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
5262

5363
- **Toolbar**:
54-
- ![login](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/login.png)**`Sign in`**:The login accounts of the two websites are not interoperable and the corresponding users need to be configured when switching websites.
55-
- ![logout](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/logout.png)**`Sign out`**:Exit the current account, if you encounter a login error, try to exit first.
56-
- ![refresh](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/refresh.png)**`Refresh`**:You can also refresh and load questions if you are not logged in, but you cannot submit it.
57-
- ![find](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/find.png)**`Find`**:Input the content and press Enter to search , press again to search for the next one. It can only search under the question bank node.
58-
- ![collapse](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/collapseAll.png)**`Collapse`**:Collapse all nodes.
59-
- ![config](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/config.png)**`Settings`**:Quick jump to the configuration page.
60-
- ![clear](https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/clear.png)**`Clear`**:Clean up the files in the configured cache directories. The cache directories of the two websites are different and only the current configured websites are cleaned up. Carefully clean up cases without submitting.
61-
62-
- **Tree**:
63-
- **`Problems`**:All questions
64-
- **`Difficulty`**:Classification of difficulties
65-
- **`Tags`**:Classification of types
66-
- **`Explore`**:Explore content, only contains titles of the questions, exclusive content that needs to pay ; some questions are loaded in order
67-
- **`Color`**:The color represents the difficulty of the question
68-
- **`Symbol`**:The symbols of “√” and “?” represent the status of the current questions, and explores with the beginning of “$” needs to pay or that cannot be viewed due to other causes.
69-
64+
- ![login][icon:login]**`Sign in`**:The login accounts of the two websites are not interoperable and the corresponding users need to be configured when switching websites.
65+
- ![logout][icon:logout]**`Sign out`**:Exit the current account, if you encounter a login error, try to exit first.
66+
- ![refresh][icon:refresh]**`Refresh`**:You can also refresh and load questions if you are not logged in, but you cannot submit it.
67+
- ![pick][icon:pick]**`pick`**:Open a problem randomly.
68+
- ![find][icon:find]**`Find`**:Open filter panel. You can search, filter and sort.
69+
- ![progress][icon:progress]**`Session`**:Open the Session panel. You can view or switch sessions.
70+
- ![toggle][icon:toggle]**`Toggle List`**:Switch to other list windows, including "All Problem List" , "Paginated Problem List" , "CodeTop Problem List".
71+
- ![config][icon:config]**`Settings`**:Quick jump to the configuration page.
72+
- ![clear][icon:clear]**`Clear`**:Clean up the files in the configured cache directories. The cache directories of the two websites are different and only the current configured websites are cleaned up. Carefully clean up cases without submitting.
73+
7074
### Menu
71-
<p align="center">
72-
<img src="https://raw.githubusercontent.com/shuzijun/leetcode-editor/master/doc/menu-3.0.png" alt="menu"/>
73-
</p>
75+
<p align="center"><img src="https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/doc/menu-3.0.jpg" alt="menu" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
76+
7477

7578
- **Menu (right-click on the questions)**:
7679
- **`open question`**:Open the question or double click on the question
@@ -83,5 +86,65 @@
8386
- **`Clear cache`**:Clean up the current question
8487
- **`Timer`**:Timer, when it is turned on, it will prompt the problem solving time in the status bar in the lower right corner
8588

89+
<br>
90+
8691
- **Editor Menu(Right-click on Editor to appear)**:
87-
Function as above
92+
Function as above
93+
94+
<br>
95+
96+
- **Question Editor**:
97+
- **`Content`**:Show content(Rely on Markdown)
98+
- **`Solution`**:show solution
99+
- **`Submissions`**:View the submission record
100+
- **`Note`**:Show note
101+
102+
### Support and Donations
103+
* [donate][shuzijun-donate]
104+
105+
106+
[plugin-logo]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/META-INF/pluginIcon.svg
107+
108+
[badge:plugin-homepage]: https://img.shields.io/badge/Plugin%20Home-Leetcode%20Editor-blue?logo=jetbrains&style=flat-square
109+
[badge:plugin-homepage-pro]: https://img.shields.io/badge/Pro%20Plugin%20Home-Leetcode%20Editor%20Pro-blue?logo=jetbrains&style=flat-square&color=blueviolet
110+
[badge:release]: https://img.shields.io/github/workflow/status/shuzijun/leetcode-editor/Release?style=flat-square&logo=github&label=Build
111+
[badge:snapshot]: https://img.shields.io/github/workflow/status/shuzijun/leetcode-editor/Snapshot?style=flat-square&logo=github&label=Build
112+
[badge:license]: https://img.shields.io/github/license/shuzijun/leetcode-editor.svg?style=flat-square&&label=License
113+
[badge:downloads]: https://img.shields.io/jetbrains/plugin/d/12132?style=flat-square&label=Plugin%20Downloads&logo=jetbrains
114+
[badge:version]: https://img.shields.io/jetbrains/plugin/v/12132?label=Plugin%20Version&logo=jetbrains&style=flat-square
115+
[badge:pro-version]: https://img.shields.io/jetbrains/plugin/v/17166?label=Pro%20Plugin%20Version&logo=jetbrains&style=flat-square&color=blueviolet
116+
[badge:en-doc]: https://img.shields.io/badge/Docs-English%20Document-blue?logo=docs&style=flat-square
117+
[badge:zh-doc]: https://img.shields.io/badge/Docs-中文文档-blue?logo=docs&style=flat-square
118+
[badge:donate]: https://img.shields.io/badge/Docs-donate-ff69c4?logo=docs&style=flat-square
119+
[badge:referrals]: https://img.shields.io/badge/Docs-referrals-ff69c4?logo=docs&style=flat-square
120+
121+
[icon:leetcode]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/LeetCode_dark.svg
122+
[icon:login]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/login_dark.svg
123+
[icon:logout]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/logout_dark.svg
124+
[icon:refresh]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/refresh_dark.svg
125+
[icon:pick]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/random_dark.svg
126+
[icon:find]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/find_dark.svg
127+
[icon:progress]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/progress_dark.svg
128+
[icon:toggle]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/src/main/resources/icons/toggle_dark.svg
129+
[icon:config]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/src/main/resources/icons/config_lc_dark.svg
130+
[icon:clear]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/clear_dark.svg
131+
132+
[gh:leetcode-editor]: https://github.com/shuzijun/leetcode-editor
133+
[gh:releases]: https://github.com/shuzijun/leetcode-editor/releases
134+
[gh:snapshot]: https://github.com/shuzijun/leetcode-editor/actions?query=workflow%3ASnapshot
135+
[gh:license]: https://github.com/shuzijun/leetcode-editor/blob/master/LICENSE
136+
[gh:en-doc]: #Introduction
137+
[gh:zh-doc]: https://github.com/shuzijun/leetcode-editor/blob/master/README_ZH.md
138+
[gh:login-help]: https://github.com/shuzijun/leetcode-editor/blob/master/doc/LoginHelp.md
139+
[gh:custom-code]: https://github.com/shuzijun/leetcode-editor/blob/master/doc/CustomCode.md
140+
[gh:leetcode-question]: https://github.com/shuzijun/leetcode-question
141+
[gh:question]: https://github.com/shuzijun/leetcode-editor/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98
142+
143+
[plugin-homepage]: https://plugins.jetbrains.com/plugin/12132-leetcode-editor
144+
[plugin-versions]: https://plugins.jetbrains.com/plugin/12132-leetcode-editor/versions
145+
[plugin-homepage-pro]: https://plugins.jetbrains.com/plugin/17166-leetcode-editor-pro
146+
[plugin-versions-pro]: https://plugins.jetbrains.com/plugin/17166-leetcode-editor-pro/versions
147+
[managing-plugins]: https://www.jetbrains.com/help/idea/managing-plugins.html
148+
149+
[shuzijun-donate]: https://shuzijun.cn/donate.html
150+
[shuzijun-referrals]: https://shuzijun.cn/referrals.html

README_ZH.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
[![English Document][badge:en-doc]][gh:en-doc]
1212
[![中文文档][badge:zh-doc]][gh:zh-doc]
1313
[![捐赠][badge:donate]][shuzijun-donate]
14-
[![中文文档][badge:referrals]][shuzijun-referrals]
14+
[![内推][badge:referrals]][shuzijun-referrals]
1515

1616
<p align="center"><img src="https://s1.imagehub.cc/images/2022/07/10/leetcode-demo.gif" alt="demo" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
1717

@@ -37,7 +37,7 @@
3737
<p align="center"><img src="https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@sync/doc/customConfig-100.gif" alt="loacl" style="width: auto;height: auto;max-width: 90%; max-height: 90%;"></p>
3838

3939

40-
### 安装
40+
### 安装([help][managing-plugins])
4141
- **通过插件库安装** [leetcode-editor][plugin-homepage]
4242
- **下载文件安装** [releases][gh:releases]
4343
- **如果您想捐助此项目,可以选择Pro版本** [leetcode-editor-pro][plugin-homepage-pro]
@@ -54,7 +54,7 @@
5454
- **`Password`**: 登录密码
5555
- **`Temp File Path`**: 临时文件存放目录
5656
- **`proxy(HTTP Proxy)`**: 使用http代理,配置路径:`File` -> `settings`->`Appearance & Behavior`->`System Settings`->`HTTP Proxy`
57-
- **`Custom code template`**: 自定义代码生成模板 ([详细介绍](https://github.com/shuzijun/leetcode-editor/blob/master/doc/CustomCode_ZH.md))([示例](https://github.com/shuzijun/leetcode-question))
57+
- **`Custom code template`**: 自定义代码生成模板 ([详细介绍][gh:custom-code-zh])([示例][gh:leetcode-question])
5858
- **`LevelColour`**: 自定义题目难度颜色,重启后生效
5959
- **`English Content`**: 题目显示英文描述
6060

@@ -121,8 +121,8 @@
121121
[badge:pro-version]: https://img.shields.io/jetbrains/plugin/v/17166?label=Pro%20Plugin%20Version&logo=jetbrains&style=flat-square&color=blueviolet
122122
[badge:en-doc]: https://img.shields.io/badge/Docs-English%20Document-blue?logo=docs&style=flat-square
123123
[badge:zh-doc]: https://img.shields.io/badge/Docs-中文文档-blue?logo=docs&style=flat-square
124-
[badge:donate]: https://img.shields.io/badge/Docs-捐赠-blue?logo=docs&style=flat-square
125-
[badge:referrals]: https://img.shields.io/badge/Docs-内推-blue?logo=docs&style=flat-square
124+
[badge:donate]: https://img.shields.io/badge/Docs-捐赠-ff69c4?logo=docs&style=flat-square
125+
[badge:referrals]: https://img.shields.io/badge/Docs-内推-ff69c4?logo=docs&style=flat-square
126126

127127

128128
[icon:leetcode]: https://cdn.jsdelivr.net/gh/shuzijun/leetcode-editor@master/src/main/resources/icons/LeetCode_dark.svg
@@ -145,7 +145,7 @@
145145
[gh:en-doc]: https://github.com/shuzijun/leetcode-editor/blob/master/README.md
146146
[gh:zh-doc]: #简介
147147
[gh:login-help]: https://github.com/shuzijun/leetcode-editor/blob/master/doc/LoginHelp_ZH.md
148-
[gh:custom-code-zh]: https://github.com/shuzijun/leetcode-editor/blob/master/doc/LoginHelp_ZH.md
148+
[gh:custom-code-zh]: https://github.com/shuzijun/leetcode-editor/blob/master/doc/CustomCode_ZH.md
149149
[gh:leetcode-question]: https://github.com/shuzijun/leetcode-question
150150
[gh:question]: https://github.com/shuzijun/leetcode-editor/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98
151151

@@ -156,5 +156,3 @@
156156

157157
[shuzijun-donate]: https://shuzijun.cn/donate.html
158158
[shuzijun-referrals]: https://shuzijun.cn/referrals.html
159-
160-
[image:demo]:

0 commit comments

Comments
 (0)