Typedoc: Syntax highlighting on typedoc.org

Created on 16 May 2020  路  5Comments  路  Source: TypeStrong/typedoc

Right now, there is no syntax highlighting on https://typedoc.org. This is especially annoying on the doc comments page - https://typedoc.org/guides/doccomments/

We should at least have syntax highlighting for TypeScript, but there might be other languages on the site that it should also be included for (none off the top of my head...)

docs good first issue help wanted
Source
picture Gerrit0

All 5 comments

I'd suggest using https://github.com/googlearchive/code-prettify
It's been archived but still works really nicely, and you can define your own custom set of symbols to highlight with colors and what not

StoneT2000 picture StoneT2000 on 16 May 2020

@Gerrit0 As the site is built using Jekyll, I would suggest using the inbuild highlighter for Jekyll. Rouge. If it's okay I can create a PR.

sidthesloth92 picture sidthesloth92 on 17 Sep 2020
👍1

That would be great!

Gerrit0 picture Gerrit0 on 17 Sep 2020
👍1

@Gerrit0 I've created the PR: https://github.com/TypeStrong/typedoc-site/pull/29. Let me know.

sidthesloth92 picture sidthesloth92 on 19 Sep 2020

Resolved by https://github.com/TypeStrong/typedoc-site/pull/29

Gerrit0 picture Gerrit0 on 19 Sep 2020
Was this page helpful?
0 / 5 - 0 ratings

Related issues

cfischer picture cfischer  路  4Comments
rbuckton picture rbuckton  路  3Comments
mcmath picture mcmath  路  3Comments
KevinEady picture KevinEady  路  3Comments
topherfangio picture topherfangio  路  3Comments