Skip to content

(未完成开发)让我们编辑 Vuepress 生成的文档如此简单!vuepress-plugin-editable + veaba-bot,尚未支持 Clone 用户使用。(以下英文乱写的:Let's editing vuepress generate docs so easy!) Not support clone user yet!

Notifications You must be signed in to change notification settings

veaba/vuepress-plugin-editable

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vuepress-plugin-editable

Downloads Version release docs CI

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-botveaba-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

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

  • vuepress ecosystem

  • plain text mode: HTML setting contenteditable:true redirect pull request.

  • complex text mode: diff origin source file content.

  • success/error alert ui

Bug

Listed not supported yet!

  1. custom container
::: warning
*here be dragons*
:::
  1. definition code
:   Definition 2

        { some code, part of Definition 2 }

    Third paragraph of definition 2.
  1. img

  2. table

  3. code

  4. Emphasis

**This is bold text**

__This is bold text__

*This is italic text*

_This is italic text_

~~StrikeThrough~~
  1. Positioning is not accurate

  2. H1-H6 auth block position has been mask.

  3. BUG: 再次发起请求时,应该关闭 dialog

API

options

name description default
appDomain https://bot.veaba.me
getContentAPI /api/content/get
updateAPI /api/content/update
redirectAPI /api/redirect/github
clientId Github APP client id {clientId}

Reference

contributors

test1

veaba.svg

test2

veaba.svg

About

(未完成开发)让我们编辑 Vuepress 生成的文档如此简单!vuepress-plugin-editable + veaba-bot,尚未支持 Clone 用户使用。(以下英文乱写的:Let's editing vuepress generate docs so easy!) Not support clone user yet!

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published