Trigger syntax highlighting for code examples about cppcoreguidelines HOT 12 CLOSED

Thanks for the suggestion.
It is noteworthy that this is an issue that divides reasonable people, especially the larger C++ community, in many ways. Some people wonder if we should similarly systematically highlight verbs and nouns in every English sentence we write :-)
For now, we are doing without syntax highlighting, but we will definitely keep syntax highlighting in mind (e.g. comments formatted differently).

The issue about fenced code block syntax is more substantive, I think. It would require lot of work to fix, but I suspect having an open issue won't hurt. Thanks!

from cppcoreguidelines.

Just for the record: It apparently (I havent't tested it) is possible to turn off syntax highlighting in Github:

1. Install the Stylish browser-addon (Firefox, Chrome).
2. Use this stylesheet.

from cppcoreguidelines.

FYI: there is already a massive PR for this: #96

from cppcoreguidelines.

@torbjoernk ty, I haven't found this issue before making the PR :D
The PR is massive because I removed all first tabulations that become useless after moving to syntax highlighting.

@gdr-at-ms,
The PR should be review quickly or there will be easily some conflict to fix.

from cppcoreguidelines.

@Liryna Yes; we have all been busy this week; will get to that.

from cppcoreguidelines.

We prefer the simple, non-syntax highlighted code blocks for the time being. Thank you, @Liryna, for making the PR but we're not merging it at the time. Sorry!

from cppcoreguidelines.

Since @gdr-at-ms said "The issue about fenced code block syntax is more substantive, I think. It would require lot of work to fix, ..."
I hope you realize you can take the PR by @Liryna, then run find/replace

```c++\n -> ```\n

and you're done.

from cppcoreguidelines.

what's the reason for not using syntax highlighting in the documentation?

from cppcoreguidelines.

@skyrpex not all flavors of markdown support such a thing. In a word: portability.

from cppcoreguidelines.

Regarding mere fencing: Note there is a tool that reformats markdown: https://github.com/wooorm/mdast. Getting the file to be idempotent would be very useful.

It's not quite the case yet, but in case you get interested, I get close with this .mdastrc:

{
  "settings": {
    "bullet": "*",
    "listItemIndent": "1",
    "strong": "*",
    "emphasis": "*"
  }
}

By adding "fences": true this will create fences (mostly correct, a handful of cases must be fixed manually).

Regarding syntax highlighting, note I could get this on github pages via Jekyll configuration: #146 without changing the source.

from cppcoreguidelines.

Thanks for the suggestion, @tkruse

from cppcoreguidelines.

to be portable dont need be ugly

from cppcoreguidelines.