Rewrite speaker note system · google/comprehensive-rust#1232

2023-09-22T08:17:02.000Z

The [`speaker-notes.js`](https://github.com/google/comprehensive-rust/blob/main/theme/speaker-notes.js) file is a little home-grown system for injecting speaker notes to the pages. I would like to rewrite this to use a more modern development style: - we should minimize the code when publishing the course - we should make the label ("Speaker Notes") translatable! - we could perhaps use a library for some of the state logic? - we could take advantage of https://github.com/google/mdbook-i18n-helpers/issues/70 when it's ready to do less on the fly DOM manipulation

(1 留言) (0 反應) (0 負責人)Rust (32,954 star) (2,009 fork)batch import

good first issuehelp wanted

描述

The speaker-notes.js file is a little home-grown system for injecting speaker notes to the pages.

I would like to rewrite this to use a more modern development style:

we should minimize the code when publishing the course
we should make the label ("Speaker Notes") translatable!
we could perhaps use a library for some of the state logic?
we could take advantage of https://github.com/google/mdbook-i18n-helpers/issues/70 when it's ready to do less on the fly DOM manipulation

貢獻者指南

技術棧: javascript
領域: documentationinternationalizationlocalization
議題類型: refactor
難度: 3
預計時間: 3-5 days
活動狀態: stale
清晰度: clear
前置要求: familiarity with speaker notes.jsJavaScript knowledge
新手友善度: 60
研究方向: Start by reading the current speaker notes.js file to understand the existing DOM manipulation and state logic. Investigate the linked mdbook i18n helpers issue #70 for planned features that could simplify the rewrite. Look into lightweight JavaScript libraries for state management that would minimize code size. Ensure the new system supports making the 'Speaker Notes' label translatable, likely by integrating with the i18n helpers.