Improving readability of documentation tables

未关闭
#311 5 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
55/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
冷清
技术栈
css
领域
design, documentation

调研方向

首先，使用 issue 中提到的 .py.method 和 .describe 选择器定位文档主题的 CSS 和标记。将当前的表格样式与提供的示例进行比较，然后验证交替背景和调整后的间距能够提高可读性，同时不会突出显示非预期元素。

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

描述

Documentation

I was reading through the documentation and I thought of a way you could make it read better.
You could do the thing thats done with tables where you alternate the background color to make the elements easier to distinguish at a glance.

I made a quick example using inspect element to color every other method in the documentation.
Image

vs what it looks like currently.
Image

My quick test was done by adding

.py.method:nth-child(odd) {
  background-color: #2d2d2d;
}

And replacing the margin on the dl elements with padding so the background color would fill it.

I originally used dl:nth-child(odd) but .py.method:nth-child(odd) worked better, but it would probably be better to add a new class to the elements you want highlight instead, because dl:nth-child(odd) highlights too much and .py.method:nth-child(odd) doesnt highlight all of the elements you would probably want highlighted.

*:is(.py.method, .describe):nth-child(odd of *:is(.py.method, .describe)) {
   background-color: #2b2b2b;
}

Should work but adding a new class is probably easier to maintain and you could reuse it in more places.

主要语言
CSS
星标
90
派生
78
平均合并
2 天 19 小时
30 天内合并 PR
4

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

python/python-docs-theme 的其他 Issue

查看 python/python-docs-theme 的全部 Issue

相似的 Issue

更多 Design Issue

把新 issue 发到你的邮箱

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