[#1958] Use syntax coloring for code blocks in docs #2099
Conversation
docs/dg/styleGuides.md
Outdated
| ``` | ||
| Not okay (Only mentions zoneId parameter): | ||
| ```java | ||
| //Not okay (Only mentions zoneId parameter): |
There was a problem hiding this comment.
| //Not okay (Only mentions zoneId parameter): | |
| // Not okay (Only mentions zoneId parameter): |
Would be good to add a space here after the comment, and update the other // for consistency as well.
There was a problem hiding this comment.
Oh oops, I must have forgotten to add the space after changing all the code blocks. It should be fixed in the new commit!
docs/dg/learningBasics.md
Outdated
| .active-text { | ||
| color: mui-color('green'); | ||
| } | ||
| ``` | ||
|
|
||
| In `c-summary-charts.vue`, locate `summary-chart__title--name`, and add the following to its `v-bind:class` attribute map. | ||
|
|
||
| ``` | ||
| ```vue |
There was a problem hiding this comment.
I don't believe MarkBind supports the vue code block, perhaps we could either use another code block syntax highlighting, or remove it altogether.
There was a problem hiding this comment.
I see, I have removed the vue tag from the code, it should look better now!
There was a problem hiding this comment.
LGTM!
Looks like Markbind uses highlight.js for syntax highlighting, and it doesn't seem to support Vue.
Also since we are using Pug + Vue, it probably won't be straightforward to configure syntax highlighting for our Vue files. I think we can just leave those blocks as is.
|
The following links are for previewing this pull request:
|
Fixes #1958
Proposed commit message
Other information
N/A