apache / apache/iotdb

Add the content sidebar of a singe markdown file to the website

未关闭
#3,383 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Java
星标
6.4k
派生
1.2k
平均合并
1 天 23 小时
30 天内合并 PR
115

描述

Now the IoTDB [website](https://iotdb.apache.org/UserGuide/Master/QuickStart/QuickStart.html) has the left sidebar to guide through different markdown files,
but lacks the right sidebar to guide through the different sections in a single markdown file.
It's easy to get lost when reading a long markdown without a content sidebar.
![image](https://user-images.githubusercontent.com/33376433/121475237-ba061d00-c9f7-11eb-8227-34e6dc647af5.png)
![image](https://user-images.githubusercontent.com/33376433/121475750-67793080-c9f8-11eb-8d16-644b3839cd35.png)

贡献指南

打开贡献指南

调研方向

未指定源文件、测试或入口点。首先检查链接的 IoTDB 网站,查找其 Markdown 页面是如何生成的;确认章节标题是如何表示的。完成标准是:较长的单页 Markdown 文档会显示右侧的内容侧边栏,其中链接到文档的各个章节。

由索引模型根据 Issue 内容生成。

评估

技术栈
markdown
领域
documentation, web-dev
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
需要澄清
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。