Skip to content

doc: gh markdown style code blocks

Rodrigo Muino Tomonari requested to merge github/fork/eljefedelrodeodeljefe/feature/doc-gh-markdown-style-code-blocks into master

As per discussion on nodejs/node#4726

This changes the code blocks from indentation to ``` for better syntax highlighting.

On the fly changes for typos and highlight breaking markdown have been made. Amongst others this includes:

  • escaping of asterisks
  • escaping of underscores e.g. __dirname
  • various typos
  • wrong brackets, wrong quotes, forgotten brackets, forgotten quotes
  • existing code block starts of javascript to js

Improved: JSON / object notation wasn't consistent. Replaced most with:

{
  key: 'value'
}

Known issues:

  • not every JSON / object notation has been improved. Should make another run for this.
  • some example functions break highlighting due to various combinations of brackets. However changing them means leaving the code style.

I would regard 9df0ba4 as optional. It would be a little nicer to have .md though. The choice of extension is from somewhen in 2010, when I see this right, here.

doc: renamed doc files to .md, adapted build scripts This is for consistency and a little less noise for the eye as in vm.markdown (2 against 8 chars) moved to second PR

Merge request reports