Improving readability of documentation tables
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 55/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Ruhig
- Tech-Stack
- css
- Bereich
- design, documentation
Rechercherichtung
Beginne damit, das CSS und Markup des Dokumentationsthemas mithilfe der im Issue erwähnten Selektoren .py.method und .describe zu finden. Vergleiche die aktuelle Tabellengestaltung mit den bereitgestellten Beispielen und überprüfe anschließend, dass abwechselnde Hintergründe und angepasste Abstände die Lesbarkeit verbessern, ohne unbeabsichtigte Elemente hervorzuheben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
vs what it looks like currently.
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.
- Vorherrschende Sprache
- CSS
- Sterne
- 90
- Forks
- 78
- Ø Merge
- 2 T. 19 Std.
- Gemergte PRs (30 T.)
- 4
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus python/python-docs-theme
-
bug help wanted
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
python/python-docs-theme#289 · 7 Kommentare · 2 Reaktionen ·
-
Docs Python.org button Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
python/python-docs-theme#217 · 7 Kommentare · 1 Reaktion ·
-
enhancement github_actions
python/python-docs-theme#260 · 6 Kommentare · 1 zugewiesene Person ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 35/100
python/python-docs-theme#245 · 3 Kommentare ·
-
enhancement help wanted
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100
python/python-docs-theme#192 · 9 Kommentare ·
Alle Issues in python/python-docs-theme
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
lobehub/lobe-icons#422 · 1 Kommentar ·
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 66/100
henit-chobisa/deck#20 ·
-
2-medium bug UI Editor ui/ux
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 72/100
decentraland/creator-hub#1628 ·
-
Request: Lean Offennew icon permissions in review
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
simple-icons/simple-icons#15031 ·