docs(readme): `translator`

kawreauthored 2 years ago

parent bc9db82commit 020184dc30fb9272799592974468101570052e3bBrowse files

+10-14README.md

		@@ -80,6 +80,7 @@ To see full configuration types see [template.lua](./lua/leetcode/config/templat
80	80
81	81	cn = { -- leetcode.cn
82	82	enabled = false, ---@type boolean
	83	+ translator = true, ---@type boolean
83	84	translate_problems = true, ---@type boolean
84	85	},
85	86
		@@ -96,28 +97,28 @@ To see full configuration types see [template.lua](./lua/leetcode/config/templat
96	97	console = {
97	98	open_on_runcode = true, ---@type boolean
98	99
99		- dir = "row", ---@type "col" \| "row"
	100	+ dir = "row", ---@type lc.direction
100	101
101		- size = {
102		- width = "90%", ---@type string \| integer
103		- height = "75%", ---@type string \| integer
	102	+ size = { ---@type lc.size
	103	+ width = "90%",
	104	+ height = "75%",
104	105	},
105	106
106	107	result = {
107		- size = "60%", ---@type string \| integer
	108	+ size = "60%", ---@type lc.size
108	109	},
109	110
110	111	testcase = {
111	112	virt_text = true, ---@type boolean
112	113
113		- size = "40%", ---@type string \| integer
	114	+ size = "40%", ---@type lc.size
114	115	},
115	116	},
116	117
117	118	description = {
118		- position = "left", ---@type "top" \| "right" \| "bottom" \| "left"
	119	+ position = "left", ---@type lc.position
119	120
120		- width = "40%", ---@type string \| integer
	121	+ width = "40%", ---@type lc.size
121	122	},
122	123
123	124	hooks = {
		@@ -160,6 +161,7 @@ Use [leetcode.cn] instead of [leetcode.com][leetcode]
160	161	```lua
161	162	cn = { -- leetcode.cn
162	163	enabled = false, ---@type boolean
	164	+ translator = true, ---@type boolean
163	165	translate_problems = true, ---@type boolean
164	166	},
165	167	```
		@@ -263,12 +265,6 @@ Meaning that to launch [leetcode.nvim] you have to pass
263	265	nvim leetcode.nvim
264	266	```
265	267
266		-### Pop-ups
267		-
268		-🚨 _Do not_ close [leetcode.nvim] pop-ups with `:q` 🚨
269		-
270		-There are two shortcuts specifically designed for closing them which are `q` and `Esc`.
271		-
272	268	### Sign In
273	269
274	270	It is required to be signed-in to use [leetcode.nvim]

+14-10README.zh.md

		@@ -84,6 +84,7 @@ https://github.com/kawre/leetcode.nvim/assets/69250723/309088c9-4ff7-4dff-ab61-a
84	84
85	85	cn = { -- leetcode.cn
86	86	enabled = false, ---@type boolean
	87	+ translator = true, ---@type boolean
87	88	translate_problems = true, ---@type boolean
88	89	},
89	90
		@@ -100,28 +101,28 @@ https://github.com/kawre/leetcode.nvim/assets/69250723/309088c9-4ff7-4dff-ab61-a
100	101	console = {
101	102	open_on_runcode = true, ---@type boolean
102	103
103		- dir = "row", ---@type "col" \| "row"
	104	+ dir = "row", ---@type lc.direction
104	105
105		- size = {
106		- width = "90%", ---@type string \| integer
107		- height = "75%", ---@type string \| integer
	106	+ size = { ---@type lc.size
	107	+ width = "90%",
	108	+ height = "75%",
108	109	},
109	110
110	111	result = {
111		- size = "60%", ---@type string \| integer
	112	+ size = "60%", ---@type lc.size
112	113	},
113	114
114	115	testcase = {
115	116	virt_text = true, ---@type boolean
116	117
117		- size = "40%", ---@type string \| integer
	118	+ size = "40%", ---@type lc.size
118	119	},
119	120	},
120	121
121	122	description = {
122		- position = "left", ---@type "top" \| "right" \| "bottom" \| "left"
	123	+ position = "left", ---@type lc.position
123	124
124		- width = "40%", ---@type string \| integer
	125	+ width = "40%", ---@type lc.size
125	126	},
126	127
127	128	hooks = {
		@@ -162,8 +163,11 @@ lang = "cpp"
162	163	将 [leetcode.com][leetcode] 替换为 [leetcode.cn]
163	164
164	165	```lua
165		----@type lc.domain
166		-domain = "com" -- 目前仅支持 "com"
	166	+cn = { -- leetcode.cn
	167	+ enabled = false, ---@type boolean
	168	+ translator = true, ---@type boolean
	169	+ translate_problems = true, ---@type boolean
	170	+},
167	171	```
168	172
169	173	### directory

+1-1lua/leetcode/config/template.lua

		@@ -47,8 +47,8 @@ local M = {
47	47
48	48	cn = { -- leetcode.cn
49	49	enabled = false, ---@type boolean
50		- translate_problems = true, ---@type boolean
51	50	translator = true, ---@type boolean
	51	+ translate_problems = true, ---@type boolean
52	52	},
53	53
54	54	---@type string