Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ref: using pangu.js for chinese documentation lint #4656

Merged
merged 11 commits into from
May 6, 2020
Merged

ref: using pangu.js for chinese documentation lint #4656

merged 11 commits into from
May 6, 2020

Conversation

NeverBehave
Copy link
Collaborator

Related: #4654

  • 重构了format.js, 并设定了仅整理将要提交的文档

    • format指令依然排版所有文件
  • 增加了自动中文排版, 基于pangu.js

  • 检查了所有目前被修订的文档并修正了部分风格不统一的部分

    • 部分:, \ 被编码是因为GFM规范, 不影响显示
  • 目前没有自动修订README.md文件(子目录, install, joinus, etc.)

@vercel
Copy link

vercel bot commented May 3, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/diy/rsshub/glg72hqhf
✅ Preview: https://rsshub-git-fork-neverbehave-pangu.diy.now.sh

docs/traditional-media.md Outdated Show resolved Hide resolved
docs/multimedia.md Outdated Show resolved Hide resolved
@HenryQW
Copy link
Collaborator

HenryQW commented May 3, 2020

\| 是会影响显示效果的

image

可以在输出的时候用 .replace(/\\\|/g, '|') 解决

@NeverBehave
Copy link
Collaborator Author

\| 是会影响显示效果的

image

可以在输出的时候用 .replace(/\\\|/g, '|') 解决

这个是因为书写不规范造成的问题, 目前都解决了

其他的部分验证过不影响显示, (如果遵守GFM的话)是应该有的escape
我顺便加上了nav部分的文件, 看看还有什么问题吧(头疼)

docs/README.md Show resolved Hide resolved
docs/install/README.md Outdated Show resolved Hide resolved
@HenryQW
Copy link
Collaborator

HenryQW commented May 3, 2020

这真是个大坑。话说为什么不包括子目录?

@NeverBehave
Copy link
Collaborator Author

这真是个大坑。话说为什么不包括子目录?

包含了啊?

@NeverBehave
Copy link
Collaborator Author

好诶, 上游处理好了

@NeverBehave
Copy link
Collaborator Author

@HenryQW 这个版本我觉得问题应该基本没有了

真的是从下修到上

docs/anime.md Outdated Show resolved Hide resolved
docs/design.md Outdated Show resolved Hide resolved
docs/design.md Outdated Show resolved Hide resolved
docs/install/README.md Show resolved Hide resolved
docs/other.md Outdated Show resolved Hide resolved
docs/parameter.md Outdated Show resolved Hide resolved
docs/parameter.md Outdated Show resolved Hide resolved
docs/programming.md Outdated Show resolved Hide resolved
docs/traditional-media.md Outdated Show resolved Hide resolved
docs/traditional-media.md Outdated Show resolved Hide resolved
@NeverBehave
Copy link
Collaborator Author

链接带空格的问题是pangu.js本身的
vinta/pangu.js#155

我现在尝试跳过这些元素好了, 看看后面他上游怎么跟进

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants