update documents

.github/ISSUE_TEMPLATE/ask-question.md

@@ -2,19 +2,22 @@
 name: Ask Question
 about: Need help while using this project
 title: "[Ask Question] "
-labels: ''
-assignees: ''
-
+labels: ""
+assignees: ""
 ---
 
 ## Describe your question
+
 <!-- A clear and concise description. -->
 
 ## What did you do before you hit this problem
+
 <!-- A clear and concise description. -->
 
 ## Information
+
 <!-- Copy and paste the output here. -->
 
 ## Additional Context
+
 <!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -2,16 +2,18 @@
 name: Feature Request
 about: Suggest an idea for this project
 title: "[Feature] "
-labels: ''
-assignees: ''
-
+labels: ""
+assignees: ""
 ---
 
 ## Please describe your idea.
+
 <!-- A clear and concise description of what the feature would do. -->
 
 ## Describe how the idea would be helpful
+
 <!-- A clear and concise description of how the feature would be helpful to users. -->
 
 ## Additional context
+
 <!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,15 +1,18 @@
 ## Purpose
+
 <!-- Please provide a brief description of the changes made in this pull request. -->
 
 ## Related Issues
+
 <!-- Please list any related GitHub issues or pull requests that this pull request addresses or closes. -->
 
 ## Changes Made
+
 <!-- Please list the detailed specific changes made in this pull request. -->
 
 ## Checklist
 
-- [ ] I have tested these changes thoroughly
-- [ ] I have updated the relevant documentation
-- [ ] I have updated any necessary dependencies
-- [ ] I have verified that the changes do not introduce any new errors or warnings
+-   [ ] I have tested these changes thoroughly
+-   [ ] I have updated the relevant documentation
+-   [ ] I have updated any necessary dependencies
+-   [ ] I have verified that the changes do not introduce any new errors or warnings

.github/SECURITY.md

@@ -29,8 +29,8 @@ We appreciate your efforts to responsibly disclose your findings and will make e
 
 We kindly ask that you follow these guidelines when reporting a security vulnerability:
 
-- Allow reasonable time for the maintainers to address the vulnerability before disclosing it to the public or a third party.
-- Do not use the vulnerability for any malicious activities or to exploit it in any way.
-- Avoid posting sensitive information or details about the vulnerability in public forums, such as social media or chat platforms.
+-   Allow reasonable time for the maintainers to address the vulnerability before disclosing it to the public or a third party.
+-   Do not use the vulnerability for any malicious activities or to exploit it in any way.
+-   Avoid posting sensitive information or details about the vulnerability in public forums, such as social media or chat platforms.
 
 By following these guidelines, you can help ensure the security and stability of our project and protect our users.

CHANGELOG.md

@@ -4,4 +4,4 @@ All notable changes to the plugin will be documented in this file.
 
 ## [1.0.0]
 
-- Initial release
+-   Initial release

CODE_OF_CONDUCT.md

@@ -16,19 +16,19 @@ As such, we pledge to be respectful, kind, and considerate towards other partici
 
 Examples of behavior that contribute to a positive environment include:
 
-* Using welcoming and inclusive language.
-* Being respectful of differing viewpoints and experiences.
-* Gracefully accepting constructive criticism.
-* Focusing on what is best for the community.
-* Showing empathy towards other community members.
+-   Using welcoming and inclusive language.
+-   Being respectful of differing viewpoints and experiences.
+-   Gracefully accepting constructive criticism.
+-   Focusing on what is best for the community.
+-   Showing empathy towards other community members.
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances.
-* Trolling, insulting/derogatory comments, and personal or political attacks.
-* Public or private harassment.
-* Publishing others' private information, such as a physical or email address, without their explicit permission.
-* Other conduct which could reasonably be considered inappropriate in a professional setting.
+-   The use of sexualized language or imagery and unwelcome sexual attention or advances.
+-   Trolling, insulting/derogatory comments, and personal or political attacks.
+-   Public or private harassment.
+-   Publishing others' private information, such as a physical or email address, without their explicit permission.
+-   Other conduct which could reasonably be considered inappropriate in a professional setting.
 
 ## 4. Enforcement Responsibilities
 
@@ -53,5 +53,3 @@ Project maintainers will follow the community impact guidelines of correction /
 This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
 
 Community Impact Guidelines were inspired by the Mozilla Community Participation Guidelines, available at https://www.mozilla.org/en-US/about/governance/policies/participation/.
-
-

README.md

@@ -7,15 +7,10 @@
 [![TAG][tag-image]][tag-url]
 
 [ci-image]: https://img.shields.io/github/actions/workflow/status/ittuann/obsidian-gpt-liteinquirer-plugin/CI.yml?branch=master&label=Build%20Status&logo=github&style=for-the-badge
-
 [ci-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin
-
 [code-scanning-image]: https://img.shields.io/github/actions/workflow/status/ittuann/obsidian-gpt-liteinquirer-plugin/CodeQL.yml?branch=master&label=Code%20Scanning&logo=github&style=for-the-badge
-
 [code-scanning-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin
-
 [tag-image]: https://img.shields.io/github/v/release/ittuann/obsidian-gpt-liteinquirer-plugin?branch=master&label=Release%20tag&logo=github&style=for-the-badge
-
 [tag-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/releases
 
 </div>
@@ -26,25 +21,24 @@ The Lightweight ChatGPT Plugin is a fast, easy-to-use, and non-intrusive AI assi
 
 If you enjoy this plugin or would like to show your support, please consider giving it a free star on GitHub~
 
+**Install and view this plugin automatically within Obsidian: [Click here](https://obsidian.md/plugins?id=gpt-liteinquirer)**
 
-**View and download this plugin: [Click here](https://obsidian.md/plugins?id=gpt-liteinquirer)**
-
+**Download manually: [Click here](https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/releases/latest)**
 
 ## Features
 
-- **Seamless integration with Obsidian:** 
-  - Enjoy the convenience of accessing lightweight ChatGPT directly within Obsidian.
-  - You no longer have to worry about being interrupted in your creative process by leaving Obsidian to switch between software.
-- **User-friendly interface:**
-  - Interact with the ChatGPT API through an intuitive and straightforward lightweight design interface.
-- **Diverse ways to use:**
-  - You can quickly input the current document as a knowledge base into ChatGPT, and ask any questions about any content. 
-  - You can also directly start a conversation with ChatGPT, quickly drafting and enriching your content, generating new ideas, or using the ChatGPT artificial intelligence to do anything you want.
-
-- **Flexible response handling:**
-  - Copy the AI-generated response to the clipboard. Alternatively, insert it directly at the cursor position in your current document, or at the end of the document.
+-   **Seamless integration with Obsidian:**
+    -   Enjoy the convenience of accessing lightweight ChatGPT directly within Obsidian.
+    -   You no longer have to worry about being interrupted in your creative process by leaving Obsidian to switch between software.
+-   **User-friendly interface:**
+    -   Interact with the ChatGPT API through an intuitive and straightforward lightweight design interface.
+-   **Diverse ways to use:**
 
+    -   You can quickly input the current document as a knowledge base into ChatGPT, and ask any questions about any content.
+    -   You can also directly start a conversation with ChatGPT, quickly drafting and enriching your content, generating new ideas, or using the ChatGPT artificial intelligence to do anything you want.
 
+-   **Flexible response handling:**
+    -   Copy the AI-generated response to the clipboard. Alternatively, insert it directly at the cursor position in your current document, or at the end of the document.
 
 ## Configuration
 
@@ -60,23 +54,21 @@ To download Obsidian: [Click here](https://www.obsidian.md/)
 
 You can open the Lightweight ChatGPT Plugin interface in three ways:
 
-- By clicking on the Obsidian ribbon on the left. 
-- By the Obsidian command `Open Lightweight Window`.
-- By manually set a keyboard shortcut for the command, such as `CTRL + K`.
+-   By clicking on the Obsidian ribbon on the left.
+-   By the Obsidian command `Open Lightweight Window`.
+-   By manually set a keyboard shortcut for the command, such as `CTRL + K`.
 
 In the GPT Lite Inquirer Window, the content you selected in the current Markdown document will be copied to the text box automatically. So you can use this text to ask questions or perform other operations, or directly write down anything you want to say.
 
 Tips: You can also send content directly using the `CTRL + ENTER` shortcut.
 
-
 ---
 
 TODO List:
 
-- [ ] Add configuration default Prompt 
-- [ ] Add support for Azure API
-- [ ] Add support for GPT-4
-- [ ] Add support for self-built API
-
+-   [ ] Add configuration default Prompt
+-   [ ] Add support for Azure API
+-   [ ] Add support for GPT-4
+-   [ ] Add support for self-built API
 
 GPT-LiteInquirer Plugin for Obsidian wants to be a nice companion to boost your creativity and productivity. Experience the seamless AI-enhanced writing and content generation capabilities within Obsidian today!

package.json

@@ -8,7 +8,7 @@
 		"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
 		"version": "node version-bump.mjs && git add manifest.json versions.json",
 		"lint": "eslint .",
-		"pretty": "prettier ./**/*.{ts,mjs,jsx,json,css,scss}"
+		"pretty": "prettier --check \"**/*.{ts,css,scss,json,mjs,jsx,md}\""
 	},
 	"pre-commit": [
 		"lint"