[Proposal] Improve TypeScript tsconfig reference web page usability
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- javascript, typescript
调研方向
首先,将原始的 TypeScript tsconfig 参考页面与链接的 mock tsconfig 参考页面及其提案概览进行比较。页面具备提议的双栏布局、搜索、经过筛选的配置部分和工具提示,并且实现已集成到 TypeScript-Website 中,即视为完成。
由索引模型根据 Issue 内容生成。
描述
Summary
When visiting the original TypeScript tsconfig reference documentation web page, the first impression right away is that the page is Brobdingnagian, overweight and overwhelming. It has all the vast amount of configuration information crammed into a single, huge page that's hard to scroll and hard to survey.
From my personal point of view, it's too hard to find pertinent information therein in a timely manner. This is particularly true for daily work, where configuring TSC is not supposed to become a full-time task.
I propose to add search and filter options to the page as well as a new page layout, supposed to resemble the powerful, simple and easy to grasp File Explorer design.
Proposal
Using the original tsconfig reference documentation web page, I created a simple mock tsconfig reference page, visualizing my proposal:

Proposal Overview
The changes are simple and easy to implement:
-
Re-arranging configuration property hyperlinks and content into two flex columns, restricting their max height to match the browser window height
-
Adding a search bar to the top of the left flex block, along with the corresponding JavaScript
-
When activating any of the configuration property hyperlinks, show filtered content in the right flex block by hiding all sections not addressed by the hyperlink
-
Add an informative tooltip to each of the configuration property hyperlinks
You find the corresponding GitHub repository containing my mock implementation here:
- 主要语言
- TypeScript
- 星标
- 2.6k
- 派生
- 1.5k
- 平均合并
- 2 天 12 小时
- 30 天内合并 PR
- 8
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
microsoft/TypeScript-Website 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 88/100
microsoft/TypeScript-Website#3611 ·
-
难度 2/5 1-3 小时 新手友好度 68/100
microsoft/TypeScript-Website#3607 ·
-
难度 1/5 1 小时以内 新手友好度 65/100
microsoft/TypeScript-Website#3039 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
microsoft/TypeScript-Website#2998 ·
-
难度 3/5 1-2 天 新手友好度 68/100
microsoft/TypeScript-Website#3614 ·
查看 microsoft/TypeScript-Website 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 75/100
-
bug v2
难度 2/5 1-3 小时 新手友好度 75/100
modelcontextprotocol/inspector#2458 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
难度 2/5 1-3 小时 新手友好度 70/100
carbon-design-system/ibm-products#9907 ·