doc: more formatting fixes by ChALkeR · Pull Request #7727 · nodejs/node

doc: more formatting fixes by ChALkeR · Pull Request #7727 · nodejs/node

added the doc

Issues and PRs related to the documentations.

label

ChALkeR changed the title ~~More doc fixes~~ doc: more formatting fixes

ChALkeR added a commit that referenced this pull request

* Add language specification for the txt code blocks.
* Move the definitions to the bottom.

Ref: #7727

Convert all instances of tab indentation in *.md files to spaces.
This affects only three files.

PR-URL: nodejs#7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

Continuing what a58b48b did for the
doc/ dir, this fixes some formatting issues in the *.md files that
are placed directly in the top-level directory.

README.md changes are excluded as they are covered by
nodejs#7971

Refs: nodejs#7637
PR-URL: nodejs#7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

This removes the extra two spaces indentation which was somewhy present
in the iojs changelog from v1.8.1 to v3.3.1.

iojs changelog was the only file affected.

PR-URL: nodejs#7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

* Add language specification for the txt code blocks.
* Move the definitions to the bottom.

Ref: nodejs#7727

PR-URL: nodejs#7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

This splits one huge commit description into paragraphs, which
supposedly was the intended behavior there.

PR-URL: nodejs#7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

ChALkeR added a commit to ChALkeR/io.js that referenced this pull request

Specifies the configuration for remark-lint, a markdown linter.

This configuration does not cause any warnings on any of the currently
present *.md files (ignoring thirdparty).

It is useful not only for possible future tooling that would check the
markdown files syntax, but also as a configuration for editor plugins,
e.g. linter-markdown for atom-linter.

Refs: nodejs#7637
Refs: nodejs#7727
Refs: nodejs#7757
PR-URL: nodejs#7729
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

cjihrig pushed a commit that referenced this pull request

Convert all instances of tab indentation in *.md files to spaces.
This affects only three files.

PR-URL: #7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

cjihrig pushed a commit that referenced this pull request

Continuing what a58b48b did for the
doc/ dir, this fixes some formatting issues in the *.md files that
are placed directly in the top-level directory.

README.md changes are excluded as they are covered by
#7971

Refs: #7637
PR-URL: #7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

cjihrig pushed a commit that referenced this pull request

This removes the extra two spaces indentation which was somewhy present
in the iojs changelog from v1.8.1 to v3.3.1.

iojs changelog was the only file affected.

PR-URL: #7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

cjihrig pushed a commit that referenced this pull request

This splits one huge commit description into paragraphs, which
supposedly was the intended behavior there.

PR-URL: #7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

cjihrig pushed a commit that referenced this pull request

Specifies the configuration for remark-lint, a markdown linter.

This configuration does not cause any warnings on any of the currently
present *.md files (ignoring thirdparty).

It is useful not only for possible future tooling that would check the
markdown files syntax, but also as a configuration for editor plugins,
e.g. linter-markdown for atom-linter.

Refs: #7637
Refs: #7727
Refs: #7757
PR-URL: #7729
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

MylesBorins pushed a commit that referenced this pull request

Specifies the configuration for remark-lint, a markdown linter.

This configuration does not cause any warnings on any of the currently
present *.md files (ignoring thirdparty).

It is useful not only for possible future tooling that would check the
markdown files syntax, but also as a configuration for editor plugins,
e.g. linter-markdown for atom-linter.

Refs: #7637
Refs: #7727
Refs: #7757
PR-URL: #7729
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

MylesBorins pushed a commit that referenced this pull request

Specifies the configuration for remark-lint, a markdown linter.

This configuration does not cause any warnings on any of the currently
present *.md files (ignoring thirdparty).

It is useful not only for possible future tooling that would check the
markdown files syntax, but also as a configuration for editor plugins,
e.g. linter-markdown for atom-linter.

Refs: #7637
Refs: #7727
Refs: #7757
PR-URL: #7729
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

rvagg pushed a commit that referenced this pull request

Specifies the configuration for remark-lint, a markdown linter.

This configuration does not cause any warnings on any of the currently
present *.md files (ignoring thirdparty).

It is useful not only for possible future tooling that would check the
markdown files syntax, but also as a configuration for editor plugins,
e.g. linter-markdown for atom-linter.

Refs: #7637
Refs: #7727
Refs: #7757
PR-URL: #7729
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>

MylesBorins pushed a commit that referenced this pull request

Specifies the configuration for remark-lint, a markdown linter.

This configuration does not cause any warnings on any of the currently
present *.md files (ignoring thirdparty).

It is useful not only for possible future tooling that would check the
markdown files syntax, but also as a configuration for editor plugins,
e.g. linter-markdown for atom-linter.

Refs: #7637
Refs: #7727
Refs: #7757
PR-URL: #7729
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>