update documents

This commit is contained in:
ittuann 2023-04-12 23:12:56 +08:00
parent 064b54c00c
commit 88f8bbaee2
No known key found for this signature in database
GPG key ID: 7F21F72109F1EA22
8 changed files with 52 additions and 54 deletions

View file

@ -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. -->

View file

@ -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. -->

View file

@ -1,10 +1,13 @@
## 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

View file

@ -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/.

View file

@ -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,9 +21,9 @@ 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
@ -38,14 +33,13 @@ If you enjoy this plugin or would like to show your support, please consider giv
- **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
You need to first set your own OpenAI API key in the Plugin Settings , so that the plugin can work properly.
@ -68,7 +62,6 @@ In the GPT Lite Inquirer Window, the content you selected in the current Markdow
Tips: You can also send content directly using the `CTRL + ENTER` shortcut.
---
TODO List:
@ -78,5 +71,4 @@ TODO List:
- [ ] 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!

View file

@ -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"