{"id":22283729,"url":"https://github.com/veaba/vuepress-plugin-editable","last_synced_at":"2025-07-28T21:33:04.016Z","repository":{"id":47445808,"uuid":"332146478","full_name":"veaba/vuepress-plugin-editable","owner":"veaba","description":"（未完成开发）让我们编辑 Vuepress 生成的文档如此简单！vuepress-plugin-editable + veaba-bot，尚未支持 Clone 用户使用。（以下英文乱写的：Let's editing vuepress generate docs so easy!） Not support clone user yet!","archived":false,"fork":false,"pushed_at":"2022-07-17T09:40:37.000Z","size":80,"stargazers_count":1,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-13T15:11:36.349Z","etag":null,"topics":["editing-vuepress"],"latest_commit_sha":null,"homepage":"https://editable.veaba.me","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/veaba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-23T06:46:48.000Z","updated_at":"2022-07-17T09:40:40.000Z","dependencies_parsed_at":"2022-08-17T14:45:50.605Z","dependency_job_id":null,"html_url":"https://github.com/veaba/vuepress-plugin-editable","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-plugin-editable","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-plugin-editable/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-plugin-editable/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veaba%2Fvuepress-plugin-editable/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/veaba","download_url":"https://codeload.github.com/veaba/vuepress-plugin-editable/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227921082,"owners_count":17840564,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["editing-vuepress"],"created_at":"2024-12-03T16:41:56.106Z","updated_at":"2024-12-03T16:41:56.716Z","avatar_url":"https://github.com/veaba.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vuepress-plugin-editable\n\n\u003cp align=\"center\"\u003e\n\n\u003ca href=\"https://npmcharts.com/compare/vuepress-plugin-editable?minimal=true\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/vuepress-plugin-editable.svg\" alt=\"Downloads\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.npmjs.com/package/vuepress-plugin-editable\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/vuepress-plugin-editable.svg\" alt=\"Version\"\u003e\u003c/a\u003e\n[![release docs CI](https://github.com/veaba/vuepress-plugin-editable/actions/workflows/release-docs.yml/badge.svg)](https://github.com/veaba/vuepress-plugin-editable/actions/workflows/release-docs.yml)\n\n\u003c/p\u003e\n\nLet's editing vuepress generate docs so easy!\n\n\u003e 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.\n\n\u003e 安全警告：目前为了方便实现功能，`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`。\n\n## Why vuepress-plugin-editable\n\nBased on vuepress + markdown ecosystem simplifies the intermediate process and can be quickly applied to the article\ncreation and revision process.\n\nYou don't even need to open vscode, you just find a mistake while reading the documentation and correct it as you go.\n\nThis will lower the threshold for developers to participate in open source documentation maintenance.\n\n## Install\n\n```sh\nnpm install -D vuepress-plugin-editable\n# OR yarn add -D vuepress-plugin-editable\n```\n\n## Usage\n\n1. Double-click on the vuepress generated content.\n\n2. OAuth github account and PR to repo's source file.\n\n## Features\n\n- [x] vuepress ecosystem\n\n- [x] plain text mode: HTML setting `contenteditable:true` redirect pull request.\n\n- [x] complex text mode: diff origin source file content.\n\n- [x] success/error alert ui\n\n## Bug\n\nListed not supported yet!\n\n1. custom container\n\n```txt\n::: warning\n*here be dragons*\n:::\n\n```\n\n2. definition code\n\n```txt\n:   Definition 2\n\n        { some code, part of Definition 2 }\n\n    Third paragraph of definition 2.\n\n```\n\n3. img\n\n4. table\n\n5. code\n\n6. Emphasis\n\n```txt\n\n**This is bold text**\n\n__This is bold text__\n\n*This is italic text*\n\n_This is italic text_\n\n~~StrikeThrough~~\n\n```\n\n7. Positioning is not accurate\n\n8. H1-H6 auth block position has been mask.\n\n9. BUG: 再次发起请求时，应该关闭 dialog\n## API\n\n### options\n\n| name          | description          | default                |\n| ------------- | -------------------- | ---------------------- |\n| appDomain     |                      | `https://bot.veaba.me` |\n| getContentAPI |                      | `/api/github/content/get`     |\n| updateAPI     |                      | `/api/github/content/update`  |\n| redirectAPI   |                      | `/api/github/auth/user` |\n| clientId      | Github APP client id | {clientId}             |\n|               |                      |                        |\n\n## Reference\n\n- [First draft](https://github.com/vuejs/docs-next-zh-cn/discussions/377#discussioncomment-298623)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveaba%2Fvuepress-plugin-editable","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveaba%2Fvuepress-plugin-editable","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveaba%2Fvuepress-plugin-editable/lists"}