freeCodeCamp/devdocs

Current page's table of contents

开放

#6 创建于 2013年10月28日

在 GitHub 查看贡献者指南
 (20 条评论) (2 个反应) (0 位负责人)Ruby (2,598 个派生)batch import
featurehelp wanted

仓库指标

星标
 (38,907 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Some documentations have very long pages that are difficult to browse through. We could improve this by adding a fixed-positioned table of contents which is automatically generated based on the current page's headings (<h2>, <h3>, etc.).

贡献者指南

研究方向
检查 DevDocs 文档页面的页面结构，以识别标题（<h2>、<h3>）是如何渲染的。查看现有的前端代码（很可能是 JavaScript），以了解如何注入一个固定定位的目录。检查仓库的文档或源文件（如 app/assets/javascripts/）中的页面渲染逻辑。考虑实现一个脚本，从标题元素生成目录并将其添加到页面中。
技术栈
javascriptcsshtml
领域
frontend
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
HTMLCSSJavaScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85