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

建议改用 docusaurus 来生成 eslint 中文文档站点 #17

Open
wangsai opened this issue Aug 15, 2020 · 0 comments
Open

建议改用 docusaurus 来生成 eslint 中文文档站点 #17

wangsai opened this issue Aug 15, 2020 · 0 comments

Comments

@wangsai
Copy link

wangsai commented Aug 15, 2020

从 eslint 7.0 开始,eslint 官网开始改用 11ty 来生成文档站点。但是,这次改版也并未对网站的导航进行优化,例如没有左侧导航,对于查看文档并不友好。

建议 eslint 中文文档可以 fork 英文网站仓库(包含了英文文档),并在 fork 的仓库中只做文档翻译,以保证和官方文档的同步。另外再重新开一个新仓库并利用 docusaurus 来生成中文文档的站点。在 docusaurus 构建时可以通过脚本自动 clone 或下载中文文档。

docusaurus 官方文档呈现的效果如链接:https://v2.docusaurus.io/docs/ ,在 markdown 渲染和左侧导航上都有很好的表现,并且页面切换时能够保留导航状态,对于查阅文档效果很好。

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

No branches or pull requests

1 participant