V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
推荐关注
Meteor
JSLint - a JavaScript code quality tool
jsFiddle
D3.js
WebStorm
推荐书目
JavaScript 权威指南第 5 版
Closure: The Definitive Guide
cy476571989
V2EX  ›  JavaScript

可以更快地查阅 ESLint 文档了!

  •  1
     
  •   cy476571989 · 2020-10-27 22:46:39 +08:00 · 1808 次点击
    这是一个创建于 1269 天前的主题,其中的信息可能已经有所发展或是发生改变。

    作为程序员,如何高效、准确地查阅文档是日常开发工作中的必备技能。

    长期以来,优秀开源项目的官方文档都是部署在国外服务器上,从国内访问非常慢,而由于众所周知的限制,部分文档服务器甚至根本就无法访问,这极大的限制了国内开发者们查看开源项目的第一手官方文档。

    为了解决这个问题,Breword 团队编写了爬虫程序,抓取开源项目存放在 Github 上的文档仓库,再部署到国内服务器,同时通过每晚自动检测原仓库是否有更新,有更新的情况下会及时同步最新的文档内容。

    最近我们爬取,整理了 ESLint 的官方文档,于是赶紧发出来跟大伙分享:

    文档地址https://docs.breword.com/eslint-eslint

    Features:

    为了提高查阅文档的效率,Breword 为所有文档网站提供了以下功能,希望能够帮助到你。

    1. 文档站内搜索🔍

      Breword 为每个文档网站内建了一个短小精悍的搜索引擎,同时会生成所有页面内容的索引列表,以便能够在客户端实现瞬时的搜索体验:

    2. 与源官方文档相同的文档目录📖

      如果你想要完整浏览文档所有内容,文档目录 毫无疑问是最有用的一个功能。

      Breword 根据项目的官方文档网站的目录,整理了文档的目录,让其跟官方文档网站保持一致:

    3. 支持移动端浏览📱

      每个文档网站都对在移动端渲染做了优化,确保在移动端也有绝佳的浏览体验:

    4. 高颜值,没有烦人的广告 😡

      简洁美观的页面布局、好看的字体,Breword 致力于为开发者提供赏心悦目的文档浏览体验。

    最后,ESLint 的文档地址为: https://docs.breword.com/eslint-eslint

    6 条回复    2020-10-28 18:37:26 +08:00
    vance123
        1
    vance123  
       2020-10-27 23:08:18 +08:00
    巧了, 我这两天也在折腾类似的事
    cy476571989
        2
    cy476571989  
    OP
       2020-10-28 08:05:04 +08:00
    @vance123 哈哈哈,真心觉得这件事还是挺有意义的,感兴趣的话,可以一起交流一下啊。
    djs
        3
    djs  
       2020-10-28 09:19:34 +08:00 via iPhone   ❤️ 1
    先发个感谢再说
    cy476571989
        4
    cy476571989  
    OP
       2020-10-28 09:33:19 +08:00
    @djs 感谢支持。
    Heanes
        5
    Heanes  
       2020-10-28 10:18:18 +08:00
    给楼主点赞,还是很好的工具的
    dongjialiu
        6
    dongjialiu  
       2020-10-28 18:37:26 +08:00
    先点赞!
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   5352 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 354ms · UTC 08:57 · PVG 16:57 · LAX 01:57 · JFK 04:57
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.