search

ros2 / design

Design documentation for ROS 2.0 effort
http://design.ros2.org/
Apache License 2.0
215 stars 194 forks source link

Add syntax highlighting #253

Closed ruffsl closed 4 years ago

ruffsl commented 4 years ago

Related: https://github.com/chrisbobbe/jekyll-theme-prologue/issues/20 http://richleland.github.io/pygments-css/ https://github.com/github/linguist/issues/1984

ruffsl commented 4 years ago

@jacobperron , could we get this merged soon? I have some upcoming PRs that could benefit from the improved readability of code snippets using rendered syntax highlighting on the static design site.

mjcarroll commented 4 years ago

Is there currently a page that would take advantage of this?

ruffsl commented 4 years ago

Is there currently a page that would take advantage of this?

Any of the pages showing XML snippets, like all of the roslauch XML or security policy schema docs. Those long schemas and sub snippets are hard to read with no tag/attribute/comment highlighting.

mjcarroll commented 4 years ago

2020-02-21-170852_2185x447_scrot

Definitely an improvement.

mjcarroll commented 4 years ago

Can you include the license for the default.css? I believe it is unlicense based on a quick look.

ruffsl commented 4 years ago

Can you include the license for the default.css?

Sure, but

I believe it is unlicense based on a quick look.

then what does that kind of license header look like?

mjcarroll commented 4 years ago

I saw this in the pygments repo: https://github.com/richleland/pygments-css/blob/master/UNLICENSE.txt

ruffsl commented 4 years ago

Ping @mjcarroll , any further actions necessary?

mjcarroll commented 4 years ago

Thanks for the improvement!