如何更快地查阅 TypeScript 文档!

2020-10-29 10:22:27 +08:00
 cy476571989

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

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

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

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

文档地址https://docs.breword.com/microsoft-TypeScript-Website/

Features:

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

  1. 文档站内搜索🔍

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

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

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

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

  3. 支持移动端浏览📱

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

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

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

最后,TypeScript 的文档地址为: https://docs.breword.com/microsoft-TypeScript-Website/

2216 次点击
所在节点    JavaScript
9 条回复
gouflv
2020-10-29 10:59:04 +08:00
体验太棒了
cy476571989
2020-10-29 11:16:39 +08:00
@gouflv 谢谢你的赞赏👍,

(提示:搜索功能很好用,因为是本地搜索,速度很快,可以尝试一下。)
muzuiget
2020-10-29 13:31:38 +08:00
我打开 www.typescriptlang.org 比你网站还快。

讲真,对这种卖国外 /国内的网络环境的推广无感,这年头谁不自带个代理。
cy476571989
2020-10-29 13:59:18 +08:00
@muzuiget 兄弟,谢谢啊,给我一盆冷水。

首先啊,`代理` 这个玩意,还真是不是谁都有的,而且有了代理,由于 距离远,依然很慢,确实 typescript 官网这个速度挺快,(估计用了国内的 Azure CDN ),但是大多数其他文档网站,速度还是挺慢的,相信你应该自己心里有明白。

将这些优秀的文档缓存起来只是 Breword 这个项目的第一步,后续还有其他功能,并不只是单纯的缓存一个网站就完事了,那也太简单了。

总之,感谢你的关注,评论。
wf18321589792
2020-10-29 14:20:21 +08:00
想法很棒,加油!
dagouziwangwang
2020-10-29 14:24:00 +08:00
体验不错!
zdhxiong
2020-10-29 19:20:42 +08:00
天呐,这是打算每个文档都来发一个帖子?
cy476571989
2020-10-29 20:14:49 +08:00
@zdhxiong 👀,只是每个文档都是最近一个一个整理出来的,所以想向大家告知一下。

后续不会每篇都发,只有较大的几个项目的文档,比较重要的,会来给大家通知一下。
abcd191898105
2020-10-30 08:36:38 +08:00
@cy476571989 都写 ts 了,没代理说不过去

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/719683

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX