polkadot-js / api / 1307

75%

push

travis-ci

fix: Fixes #204. Adds coloured syntax highlighting to TypeDoc code examples (#207)

* fix: Fixes #204. Adds coloured syntax highlighting to TypeDoc code examples

* Add Gitbook plugin Sunlight Highlighter https://www.npmjs.com/package/gitbook-plugin-sunlight-highlighter

* Still requires use of <BR> HTML element to shift code onto a new line

* Example use of Sunlight Highlighter from their README `javascript+theme:gitbook+lineNumbers:true+lineNumberStart:100` (in this example it uses their gitbook theme with line numbers shown and line numbers starting from 100)

* Updated book.json to add the Sunlight Highlighter plugin, and explicitely configured it to use the gitbook theme by default

* Enable showing line numbers only on TypeDoc example code that is longer (i.e. 8 lines long)

* fix: Remove unnecessary inline config for no line numbers since is default

* fix: Remove use of line numbers so consistent with the rest

284 of 360 branches covered (78.89%)

Branch coverage included in aggregate %.

924 of 1056 relevant lines covered (87.5%)

968.46 hits per line