Add: more description for theme option.

kenkangxgwe · Jan 13, 2019 · 4dc2e85 · 4dc2e85
1 parent 0d3da05
commit 4dc2e85
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -70,8 +70,11 @@ This is a good way to see the results from the unit tests.
 
 You may also specify the following `initializationOptions`.
 
-- `"theme": "dark" | "light"` specifies the documentation text color since it is
-rendered to SVG image for better typesetting. (Default: `dark`)
+- `"theme": "dark" | "light"` For better typesetting of documentation, SVG
+images are used in the popup such as hovering. Since the background is
+transparent, this setting is to ensure the text in the images are actually
+visible. If you use dark themes, then choose `dark` <a name="ref2">
+</a>[<sup>2</sup>](#footnote2). (Default: `dark`)
 
 ## Features
 

diff --git a/client/README.md b/client/README.md
@@ -45,7 +45,7 @@ After the extension is launched, go to **Preference -> Settings -> User Settings
 - *Theme:* For better typesetting of documentation, SVG images are used in the
 popup for hovering. Since the background is transparent, this setting is to
 ensure the text in the images are actually visible. If you use dark themes, then
-choose `dark`<a name="ref2"> </a>[<sup>2</sup>](#footnote2).
+choose `dark` <a name="ref2"> </a>[<sup>2</sup>](#footnote2).
 
 - *WLServer Path:* The path to the server repository.