fix: MD046/code-block-style

[nschonni]

Code block style of fenced to match nodejs style

[XhmikosR]

@Trott please don't merge this!

@nschonni did you run npm start locally? This throws, or at least should throw, when a prism lang is specified that doesn't exist.

For example:

Failed to load prism syntax: console
Error: Cannot find module 'prismjs/components/prism-console.js'
Require stack:
- C:\Users\xmr\Desktop\nodejs.org\node_modules\metalsmith-prism\lib\index.js
- C:\Users\xmr\Desktop\nodejs.org\build.js
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:772:15)
    at Function.Module._load (internal/modules/cjs/loader.js:677:27)
    at Module.require (internal/modules/cjs/loader.js:830:19)
    at require (internal/modules/cjs/helpers.js:68:18)
    at requireLanguage (C:\Users\xmr\Desktop\nodejs.org\node_modules\metalsmith-prism\lib\index.js:42:11)
    at Object.<anonymous> (C:\Users\xmr\Desktop\nodejs.org\node_modules\metalsmith-prism\lib\index.js:86:11)
    at initialize.exports.each (C:\Users\xmr\Desktop\nodejs.org\node_modules\cheerio\lib\api\traversing.js:300:24)
    at C:\Users\xmr\Desktop\nodejs.org\node_modules\metalsmith-prism\lib\index.js:62:17
    at C:\Users\xmr\Desktop\nodejs.org\node_modules\lodash\lodash.js:4905:15
    at baseForOwn (C:\Users\xmr\Desktop\nodejs.org\node_modules\lodash\lodash.js:2990:24) {
  code: 'MODULE_NOT_FOUND',
  requireStack: [
    'C:\\Users\\xmr\\Desktop\\nodejs.org\\node_modules\\metalsmith-prism\\lib\\index.js',
    'C:\\Users\\xmr\\Desktop\\nodejs.org\\build.js'
  ]
}

[XhmikosR]

We really need #2539, although to be fair, in this case these are wrapped in try/catch so it doesn't throw. But at least we would see them in our console.

[nschonni]

OK, just removed the "console" ones with plain blocks

[XhmikosR]

@Trott: do you know which library is used upstream for highlighting? It seems metalsmith-prism is archived, so it might be worth looking into switching to the same way it's done upstream in another PR.

[Trott]

@Trott: do you know which library is used upstream for highlighting? It seems metalsmith-prism is archived, so it might be worth looking into switching to the same way it's done upstream in another PR.

Looking at https://github.com/nodejs/node/blob/6723169097759502da11c47389ffb3d650404417/tools/doc/html.js, I guess we're using https://github.com/remarkjs/remark-rehype.

[XhmikosR]

This isn't ready IMO.

When we use fenced code blocks, we need to remove any indented code otherwise we'll end up with extra spaces in the snippets. It seems there are some cases this is missed like https://github.com/nodejs/nodejs.org/pull/2557/files#diff-74f34b44a0285dc0c6cd1f2eeed2e2b5

I didn't go through all of the changes, so I don't know if there are more.

[XhmikosR]

LGTM except for my comment above

[nschonni]

@Trott I think all the major stuff is resolved now. The indentation stuff is as-is for the existing examples

[Trott]

@Trott I think all the major stuff is resolved now. The indentation stuff is as-is for the existing examples

This is a big change set. @nodejs/website Anyone up for trying to give this a review?

[XhmikosR]

@Trott we should move forward with #2523 and #2524 so that we don't have to review the snippets manually and that we are consistent. I've left a comment on #2523.

As far as this PR goes, it's definitely an improvement. I'd only go through the snippets and fix the indentation while at it. Assuming we don't use any code block languages that prism doesn't support (like console) this should be OK. It also fixes a broken example in the pt_BR translation.

[nschonni]

Easiest way to review it is with the "whitespace ignored" option set, then you just see the code fence lines and the example fix

[XhmikosR]

Yeah, but in this case whitespace does matter. So, the only safe way is viewing the rich preview of each file which takes time though.

[XhmikosR]

This looks good to me. There are 3 unresolved comments and then it can be merged IMO.

[XhmikosR]

@nschonni can you just address the 2 indentation comments while you change the code snippets?

Otherwise someone with push rights could fix them and then just squash.