https://github.com/veaba/vuepress-plugin-editable
（未完成开发）让我们编辑 Vuepress 生成的文档如此简单！vuepress-plugin-editable + veaba-bot，尚未支持 Clone 用户使用。（以下英文乱写的：Let's editing vuepress generate docs so easy!） Not support clone user yet!
https://github.com/veaba/vuepress-plugin-editable
editing-vuepress
Last synced: 11 months ago
JSON representation
（未完成开发）让我们编辑 Vuepress 生成的文档如此简单！vuepress-plugin-editable + veaba-bot，尚未支持 Clone 用户使用。（以下英文乱写的：Let's editing vuepress generate docs so easy!） Not support clone user yet!
- Host: GitHub
- URL: https://github.com/veaba/vuepress-plugin-editable
- Owner: veaba
- Created: 2021-01-23T06:46:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-07-17T09:40:37.000Z (almost 4 years ago)
- Last Synced: 2024-10-13T15:11:36.349Z (over 1 year ago)
- Topics: editing-vuepress
- Language: JavaScript
- Homepage: https://editable.veaba.me
- Size: 78.1 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vuepress-plugin-editable
[](https://github.com/veaba/vuepress-plugin-editable/actions/workflows/release-docs.yml)
Let's editing vuepress generate docs so easy!
> Safety Warning: Currently, to facilitate functionality, veaba-bot explicitly redirects the Github AccessToken to the url of your launch oAuth page. For the security of your Github account, please always avoid revealing the AccessToken to third parties, including [veaba-bot](), veaba ](https://github.com/veaba/veaba-bot), `veaba-bot` will not keep storing your `AccessToken` information. Your `AccessToken` is passed to `veaba-bot` via the Request header `access-token` set in fetch.
> 安全警告：目前为了方便实现功能，`veaba-bot` 会显式地将 Github `AccessToken` 重定向到你的发起 oAuth 页面的 url，为了你的 Github 账号安全，请始终避免泄露 `AccessToken` 给第三方，包括 [veaba-bot](https://github.com/veaba/veaba-bot)，`veaba-bot` 不会保留存储你的 `AccessToken`信息。你的 `AccessToken` 是通过 fetch 里设置的 Request header `access-token` 传递给 `veaba-bot`。
## Why vuepress-plugin-editable
Based on vuepress + markdown ecosystem simplifies the intermediate process and can be quickly applied to the article
creation and revision process.
You don't even need to open vscode, you just find a mistake while reading the documentation and correct it as you go.
This will lower the threshold for developers to participate in open source documentation maintenance.
## Install
```sh
npm install -D vuepress-plugin-editable
# OR yarn add -D vuepress-plugin-editable
```
## Usage
1. Double-click on the vuepress generated content.
2. OAuth github account and PR to repo's source file.
## Features
- [x] vuepress ecosystem
- [x] plain text mode: HTML setting `contenteditable:true` redirect pull request.
- [x] complex text mode: diff origin source file content.
- [x] success/error alert ui
## Bug
Listed not supported yet!
1. custom container
```txt
::: warning
*here be dragons*
:::
```
2. definition code
```txt
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
```
3. img
4. table
5. code
6. Emphasis
```txt
**This is bold text**
__This is bold text__
*This is italic text*
_This is italic text_
~~StrikeThrough~~
```
7. Positioning is not accurate
8. H1-H6 auth block position has been mask.
9. BUG: 再次发起请求时，应该关闭 dialog
## API
### options
| name | description | default |
| ------------- | -------------------- | ---------------------- |
| appDomain | | `https://bot.veaba.me` |
| getContentAPI | | `/api/github/content/get` |
| updateAPI | | `/api/github/content/update` |
| redirectAPI | | `/api/github/auth/user` |
| clientId | Github APP client id | {clientId} |
| | | |
## Reference
- [First draft](https://github.com/vuejs/docs-next-zh-cn/discussions/377#discussioncomment-298623)