lowRISC / lowRISC/opentitan

[doc] Online documentation export issue

Open Beginner friendly
#26,652 0 comments 0 reactions 0 assignees View on GitHub
Component:Doc
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

### Description

The CSS for https://opentitan.org/book does not seem to be defined for printable media:

* Printing from Chrome:
![Image](https://github.com/user-attachments/assets/321226e8-08e5-477c-8340-bc5f7a451d5c)
(the ToC repeats itself on each printed page)

* Printing from Safari:
![Image](https://github.com/user-attachments/assets/c20a5b43-2dd0-4460-a206-498d040d3147)
(the ToC prints only once on the center page)

ToC and other navigation helpers should better be hidden when printable media is in use, _i.e._
````css
@media print {
/* ... */
}
````

Contributor guide

Open the contributing guide

Research direction

Start with the CSS used by https://opentitan.org/book and inspect the rules controlling the table of contents and other navigation helpers. Add print-media behavior so those helpers are hidden when printing, then verify the result in Chrome and Safari, where the current repetition and centering issues are reported.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.