Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: gh markdown style code blocks #4733

Closed
wants to merge 3 commits into from
Closed

doc: gh markdown style code blocks #4733

wants to merge 3 commits into from

Commits on Jan 20, 2016

  1. doc: unindented code blocks, typo fixes 

    This changes the code blocks from indentation to ```
for better syntax highlighting, as per discussion on node/node#4726

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 hightlighting due to various
  combinations of brackets. However changing them means leaving
  the code style.

PR-URL:
Reviewed-By:
Reviewed-By:

doc: ``` instead of ```bash

doc: reverts inline escaping of e.g. \*nix \_\_

doc: revert to typos / inconsistencies in favor for new PR
    @eljefedelrodeodeljefe
    eljefedelrodeodeljefe committed Jan 20, 2016
    Configuration menu
    Copy the full SHA
    0d6c51f View commit details
    Browse the repository at this point in the history

  2. doc: unindented code blocks, typo fixes 

    This changes the code blocks from indentation to ```
for better syntax highlighting, as per discussion on node/node#4726

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 hightlighting due to various
  combinations of brackets. However changing them means leaving
  the code style.

PR-URL:
Reviewed-By:
Reviewed-By:

doc: ``` instead of ```bash

doc: reverts inline escaping of e.g. \*nix \_\_

doc: revert to typos / inconsistencies in favor for new PR
    @eljefedelrodeodeljefe
    eljefedelrodeodeljefe committed Jan 20, 2016
    Configuration menu
    Copy the full SHA
    5c63e4c View commit details
    Browse the repository at this point in the history

  3. Merge branch 'feature/doc-gh-markdown-style-code-blocks' of https://g… 

    …ithub.com/eljefedelrodeodeljefe/node into feature/doc-gh-markdown-style-code-blocks
    @eljefedelrodeodeljefe
    eljefedelrodeodeljefe committed Jan 20, 2016
    Configuration menu
    Copy the full SHA
    921386f View commit details
    Browse the repository at this point in the history