[GitHub] [apisix-website] SkyeYoung commented on a diff in pull request #1113: docs: add IDE recommendations in README

[GitBox <gi...@apache.org>]

SkyeYoung commented on code in PR #1113:
URL: https://github.com/apache/apisix-website/pull/1113#discussion_r878828027


##########
README.md:
##########
@@ -99,6 +99,12 @@ apisix-website
     └── docusaurus.config.js
 ```
 
+#### IDE recommendations config
+
+> Help you configure your IDE quickly

Review Comment:
   ```suggestion
   > Helps you enhance your development and documentation editing experience.
   ```
   
   ditto



##########
website/docs/ide-config.md:
##########
@@ -0,0 +1,62 @@
+# Vscode
+
+> Vscode Extensions
+
+- ESLint

Review Comment:
   Why not try this way? https://stackoverflow.com/a/52580725/14728656 



##########
README.md:
##########
@@ -99,6 +99,12 @@ apisix-website
     └── docusaurus.config.js
 ```
 
+#### IDE recommendations config

Review Comment:
   ```suggestion
   #### IDE configuration and plug-in recommendations
   ```
   
   Maybe better? 🤔Please give your suggestions.😅



##########
README.md:
##########
@@ -99,6 +99,12 @@ apisix-website
     └── docusaurus.config.js
 ```
 
+#### IDE recommendations config
+
+> Help you configure your IDE quickly
+
+- [VsCode](./website/docs/ide-config.md#vscode)

Review Comment:
   ```suggestion
   - [VSCode](./website/docs/ide-config.md#vscode)
   ```
   
   `VsCode` => `VSCode`, `VS Code`, or `Visual Studio Code`



##########
website/docs/ide-config.md:
##########
@@ -0,0 +1,62 @@
+# Vscode
+
+> Vscode Extensions
+
+- ESLint
+  - id: "dbaeumer.vscode-eslint"
+  - recommend reason: "Integrates ESLint JavaScript into VS Code."
+- Stylelint
+  - id: "stylelint.vscode-stylelint"
+  - recommend reason: "Official Stylelint extension for Visual Studio Code"
+- GitLens
+  - id: "eamodio.gitlens"
+  - recommend reason: "It helps you to visualize code authorship at a glance via Git blame annotations and CodeLens"
+- markdownlit
+  - id: "DavidAnson.vscode-markdownlint"
+  - recommend reason: "Markdown linting and style checking for Visual Studio Code"
+
+> Vscode Settings
+
+```json

Review Comment:
   you can use `js` or `json5` to ignore red highlighting
   ![image](https://user-images.githubusercontent.com/48400568/169688436-bcd1bc49-ed06-4de7-b496-274d3f30a9a9.png)
   



##########
website/docs/ide-config.md:
##########
@@ -0,0 +1,62 @@
+# Vscode

Review Comment:
   ```suggestion
   # VS Code
   ```
   ditto



##########
website/docs/ide-config.md:
##########
@@ -0,0 +1,62 @@
+# Vscode
+
+> Vscode Extensions
+
+- ESLint
+  - id: "dbaeumer.vscode-eslint"
+  - recommend reason: "Integrates ESLint JavaScript into VS Code."
+- Stylelint
+  - id: "stylelint.vscode-stylelint"
+  - recommend reason: "Official Stylelint extension for Visual Studio Code"
+- GitLens
+  - id: "eamodio.gitlens"
+  - recommend reason: "It helps you to visualize code authorship at a glance via Git blame annotations and CodeLens"
+- markdownlit

Review Comment:
   ```suggestion
   - markdownlint
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org