yesmeck / waque

[不再维护]同步本地 Markdown 文档到语雀

瓦雀

双双瓦雀行书案，点点杨花入砚池。 —— 元 叶李《暮春即事》

瓦雀可以帮你把本地的文档（markdown）目录发布到语雀上。

如果你想要...

• 返璞归真，使用 markdown；
• 选择自己喜欢的编辑器；
• 把文档维护在 GitHub 上；

瓦雀是你居家旅行，编写文档的必备工具。

注：文档同步是单向的，同步的文档不能再在语雀上编辑

• 瓦雀
  • 安装瓦雀
  • 登录语雀
  • 初始化配置
  • 上传文档
  • 从已有仓库导出文档
  • 谁在使用

安装瓦雀

$ npm i -g waque

登录语雀

$ waque login

初始化配置

在文档目录下运行下面的命令生成瓦雀的配置文件 yuque.yml。

这个命令会要求你输入语雀知识库的名字和要上传的文档，可以参考配置说明来设置。

$ waque init

上传文档

使用下面的命令来上传文档，瓦雀会把文件名作为语雀上文档的 URL，所以文件名只能包含字母、数字、_和-（除非在文档里指定了 URL）。

$ waque upload

也可以指定文件上传。

$ waque upload foo.md bar.md

从已有仓库导出文档

如果你要把已有的仓库改用瓦雀管理，那么你可以用下面的命令先把文档导出成 markdown。

默认导出到当前目录下，如果指定目录，则目录要先存在。

$ waque export [DIR]

导出再上传可能碰到的问题

谁在使用

• 《Ant Design 实战教程》

waque's Issues

Support for more platforms

• 知乎 - https://github.com/shanelau/zhihu
• Segmentfault
• 掘金

怎么在 summary.md 中指定目录层次 ？

现在只能单层目录层次，怎么实现多层？

导出的文件是md，但是内容却是html

知识库地址 https://www.yuque.com/roylau/blog/learn-nodejs_pm2

对于有图片的md，如何才能把本地图片一起发布

强制覆盖「富文本格式文档」

同步时报错：

{ status: 400, message: '抱歉，语雀不允许通过 API 修改富文本格式文档，请到语雀进行操作。' }

由于雨雀僵硬的设计，一旦从 Web/客户端进入文档，点击「编辑」，就会修改文档成富文本，能不能做到通过 API 强制覆盖这个富文本？

新的电脑npm i -g waque后执行waque login后报错

» Error: Missing required flag:
» -t, --token TOKEN
» See more help with --help

能通过命令行参数指定不同的 yuque.yml 么？

在当前目录下，由于要发布测试文档到不同的 repo，故其配置可能不同：

repo: 'production/repo'
# repo: 'testing/repo'

如果能通过命令行参数指定不同的 yaml 配置就好了：

waque -conf testing.yaml upload  path/to/doc/*.md

导出的文件可以自动创建一个summary.md吗,还有就是空目录帮忙创建一下。

还有就是空目录帮忙创建个空文件夹把文档扔进去，否则上百个文档挤在一个文件夹也太难受了

无法使用中文名，能否添加将中文名编码，base64 等来作为 url

可以认证到公司的空间吗

我尝试把认证的那个网址改成公司的，一刷新又变成个人的了

如何能让git跳转和语雀跳转一致

很感谢作者制作了这个软件方便发布到语雀，刚好解决了我们项目内的文档管理这个痛点。
但是这里有一个问题，就是在编写的过程中，我们相对的地址都是根据markdown文件的位置来指定，此时上传到git上（gitlab or github）都可以跳转浏览，但是导入到语雀就不可以了。相反，如果编写时考虑语雀的目录地址，git上阅读就无法访问了，请问有什么办法可以做到兼容呢？

waque init Request failed with status code 401

E:\waque>waque init
Error: Request failed with status code 401
at createError (E:/Nodejs/node_global/node_modules/waque/node_modules/axios/lib/core/createError.js:16:15)
at settle (E:/Nodejs/node_global/node_modules/waque/node_modules/axios/lib/core/settle.js:18:12)
at IncomingMessage.handleStreamEnd (E:/Nodejs/node_global/node_modules/waque/node_modules/axios/lib/adapters/http.js
:202:11)

公司电脑没有问题，但是家里的电脑waque init 就报错
也登陆授权了

推荐OAuth取消token

利用OAuth，在传输的时候可以自定义位置

Linux terminal login failed

I'm using Linux command line to login yuque? there was no X11 install, the login failed:

request token timeout

Is it possible to login without UI?

我想在 GitHub Actions 中使用该如何配置

主要是想拉取语雀文章发布到博客

导出命令的问题！

用了一下导出命令。我设置的空节点的目录，咋全部变成空文档，路径变成了#号了。

url可以自动生成吗？

window显示找不到命令

waque: command not found
是要配置环境变量吗？如何配置？

限制下 API 的请求频率

目前语雀可能上了 API 流控，会报错：

{ status: 429, message: 'Too Many Requests' }

希望可以添加一个命令行参数，比如 --api-freq = 10 即每秒只调用 10 次 API。

---

版本信息

waque/1.13.1 linux-x64 node-v10.19.0

文件名限制缓解方案

中文名，非法符号等情况，或许可以通过拼音转换等方式缓解掉。

上传文件名称带有中文、空格等时无法正常上传

标题中带有空格、中文时无法正常上传，希望可以改进

[Feature Request] waque watch

like https://github.com/afc163/wa#start-to-watch

瓦雀的token如何配置在项目中

使用waque命令时，每次都提示需要-t 加上token，查阅了语雀的手册，有一步骤提示是配置语雀token的环境变量YUQUE_TOKEN，这一步要如何操作？

代码框编码问题

错误编码的链接: Karobben
本地文件写的
sed 's/t/T/' file
上传后, 文档却变成了
sed 's/t/T/' file
我idea 用的 atom. 请问, 这是语雀渲染md的问题, 还是瓦雀的问题呀... 搜了一下语雀, 好像, 就我一个人有这问题... 太奇怪了
在gitpage 是没任何问题的. 因为不看语雀, 所以今天才发现- -

waque init Error: Request failed with status code 401

Error: Request failed with status code 401
at createError (E:/Nodejs/node_global/node_modules/waque/node_modules/axios/lib/core/createError.js:16:15)
at settle (E:/Nodejs/node_global/node_modules/waque/node_modules/axios/lib/core/settle.js:18:12)
at IncomingMessage.handleStreamEnd (E:/Nodejs/node_global/node_modules/waque/node_modules/axios/lib/adapters/http.js
:202:11)

Missing required flag

F:\111>waque init
» Error: Missing required flag:
» -t, --token TOKEN
» See more help with --help

咋整？

本地上传时文件名不对

待上传文件截图：

原名 config.md ，$ waque upload上传到语雀后显示的是实用工具
$ waque upload config.md 还是一样的结果