chore(markdownlint) add emphasis style rule (#2623)

Author: byzyk

.markdownlint.json

@@ -5,11 +5,12 @@
   "MD007": { "indent": 4 },
   "MD013": { "line_length": 600 },
   "MD026": false,
-  "MD029": { "style": "ordered"},
+  "MD029": { "style": "ordered" },
   "MD033": false,
   "MD034": false,
   "MD036": false,
   "MD041": false,
   "no-hard-tabs": false,
-  "whitespace": false
-}
+  "whitespace": false,
+  "emphasis-style": { "style": "_" }
+}

package.json

@@ -33,7 +33,7 @@
     "init:generated": "mkdirp ./generated/loaders && mkdirp ./generated/plugins ",
     "lint": "run-s lint:*",
     "lint:js": "eslint . --ext .js,.jsx,.md",
-    "lint:markdown": "markdownlint --config ./.markdownlint.json *.md ./src/content/**/*.md",
+    "lint:markdown": "markdownlint --rules markdownlint-rule-emphasis-style --config ./.markdownlint.json *.md ./src/content/*.md ./src/content/**/*.md",
     "lint:social": "alex . -q",
     "lint:prose": "cp .proselintrc ~/ && proselint src/content",
     "test": "npm run lint",
@@ -85,8 +85,9 @@
     "loader-utils": "^1.1.0",
     "lodash": "^4.17.4",
     "markdown-loader": "^2.0.1",
-    "markdownlint": "^0.6.0",
-    "markdownlint-cli": "^0.3.1",
+    "markdownlint": "^0.11.0",
+    "markdownlint-cli": "^0.13.0",
+    "markdownlint-rule-emphasis-style": "^1.0.0",
     "marked": "^0.3.7",
     "mini-css-extract-plugin": "^0.2.0",
     "mkdirp": "^0.5.1",

src/content/api/cli.md

@@ -9,6 +9,7 @@ contributors:
   - rencire
   - madhavarshney
   - EugeneHlushko
+  - byzyk
 related:
   - title: Analyzing Build Statistics
     url: https://survivejs.com/webpack/optimizing-build/analyzing-build-statistics/
@@ -42,15 +43,15 @@ See [configuration](/configuration) for the options in the configuration file.
 webpack <entry> [<entry>] -o <output>
 ```
 
-**`<entry>`**
+__`<entry>`__
 
 A filename or a set of named filenames which act as the entry point to build your project. You can pass multiple entries (every entry is loaded on startup). If you pass a pair in the form `<name>=<request>` you can create an additional entry point. It will be mapped to the configuration option `entry`.
 
-**`<output>`**
+__`<output>`__
 
 A path and filename for the bundled file to be saved in. It will be mapped to the configuration options `output.path` and `output.filename`.
 
-**Example**
+__Example__
 
 If your project structure is as follows -
 
@@ -98,22 +99,22 @@ This will form the bundle with both the files as separate entry points.
 
 W> Note that Command Line Interface has a higher precedence for the arguments you use it with than your configuration file. For instance, if you pass [`--mode="production"`](/concepts/mode/#usage) to webpack CLI and your configuration file uses `development`, `production` will be used.
 
-**List all of the options available on the cli**
+__List all of the options available on the cli__
 
 ```bash
 webpack --help
 webpack -h
 ```
 
-**Build source using a config file**
+__Build source using a config file__
 
 Specifies a different [configuration](/configuration) file to pick up. Use this if you want to specify something different than `webpack.config.js`, which is the default.
 
 ```bash
 webpack --config example.config.js
 ```
 
-**Print result of webpack as a JSON**
+__Print result of webpack as a JSON__
 
 ```bash
 webpack --json
@@ -150,10 +151,10 @@ T> See the [environment variables](/guides/environment-variables) guide for more
 Parameter                 | Explanation                                 | Input type | Default
 ------------------------- | ------------------------------------------- | ---------- | ------------------
 `--config`                | Path to the config file                     | string     | webpack.config.js or webpackfile.js
-`--config-register, -r`   | Preload one or more modules before loading the webpack configuration | array | 
-`--config-name`           | Name of the config to use                   | string     | 
-`--env`                   | Environment passed to the config, when it is a function | 
-`--mode`                  | Mode to use, either "development" or "production" | string      | 
+`--config-register, -r`   | Preload one or more modules before loading the webpack configuration | array |
+`--config-name`           | Name of the config to use                   | string     |
+`--env`                   | Environment passed to the config, when it is a function |
+`--mode`                  | Mode to use, either "development" or "production" | string      |
 
 ### Output Options
 
@@ -211,7 +212,7 @@ Parameter    | Explanation                                      | Input type | D
 `--debug`    | Switch loaders to debug mode                     | boolean    | false
 `--devtool`  | Define [source map type](/configuration/devtool/) for the bundled resources | string | -
 `--progress` | Print compilation progress in percentage         | boolean    | false
-`--display-error-details` | Display details about errors | boolean | false 
+`--display-error-details` | Display details about errors | boolean | false
 
 ### Module Options
 
@@ -312,7 +313,6 @@ Shortcut | Replaces
 -d       | `--debug --devtool cheap-module-eval-source-map --output-pathinfo`
 -p       | `--optimize-minimize --define process.env.NODE_ENV="production"`, see [building for production](/guides/production)
 
-
 ### Profiling
 
 The `--profile` option captures timing information for each step of the compilation and includes this in the output.

src/content/api/loaders.md

@@ -12,7 +12,7 @@ A loader is just a JavaScript module that exports a function. The [loader runner
 
 The first loader is passed one argument: the content of the resource file. The compiler expects a result from the last loader. The result should be a `String` or a `Buffer` (which is converted to a string), representing the JavaScript source code of the module. An optional SourceMap result (as JSON object) may also be passed.
 
-A single result can be returned in **sync mode**. For multiple results the `this.callback()` must be called. In **async mode** `this.async()` must be called to indicate that the [loader runner](https://github.com/webpack/loader-runner) should wait for an asynchronous result. It returns `this.callback()`. Then the loader must return `undefined` and call that callback.
+A single result can be returned in __sync mode__. For multiple results the `this.callback()` must be called. In __async mode__ `this.async()` must be called to indicate that the [loader runner](https://github.com/webpack/loader-runner) should wait for an asynchronous result. It returns `this.callback()`. Then the loader must return `undefined` and call that callback.
 
 
 ## Examples
@@ -70,7 +70,7 @@ module.exports = function(content, map, meta) {
 };
 ```
 
-T> Loaders were originally designed to work in synchronous loader pipelines, like Node.js (using [enhanced-require](https://github.com/webpack/enhanced-require)), *and* asynchronous pipelines, like in webpack. However, since expensive synchronous computations are a bad idea in a single-threaded environment like Node.js, we advise to make your loader asynchronously if possible. Synchronous loaders are ok if the amount of computation is trivial.
+T> Loaders were originally designed to work in synchronous loader pipelines, like Node.js (using [enhanced-require](https://github.com/webpack/enhanced-require)), _and_ asynchronous pipelines, like in webpack. However, since expensive synchronous computations are a bad idea in a single-threaded environment like Node.js, we advise to make your loader asynchronously if possible. Synchronous loaders are ok if the amount of computation is trivial.
 
 
 ### "Raw" Loader
@@ -177,12 +177,12 @@ require('./loader1?xyz!loader2!./resource?rrr');
 
 ### `this.version`
 
-**Loader API version.** Currently `2`. This is useful for providing backwards compatibility. Using the version you can specify custom logic or fallbacks for breaking changes.
+__Loader API version.__ Currently `2`. This is useful for providing backwards compatibility. Using the version you can specify custom logic or fallbacks for breaking changes.
 
 
 ### `this.context`
 
-**The directory of the module.** Can be used as context for resolving other stuff.
+__The directory of the module.__ Can be used as context for resolving other stuff.
 
 In the example: `/abc` because `resource.js` is in this directory
 

src/content/api/module-methods.md

@@ -419,4 +419,4 @@ const page = 'Foo';
 __webpack_modules__[require.resolveWeak(`./page/${page}`)];
 ```
 
-T> `require.resolveWeak` is the foundation of *universal rendering* (SSR + Code Splitting), as used in packages such as [react-universal-component](https://github.com/faceyspacey/react-universal-component). It allows code to render synchronously on both the server and initial page-loads on the client. It requires that chunks are manually served or somehow available. It's able to require modules without indicating they should be bundled into a chunk. It's used in conjunction with `import()` which takes over when user navigation triggers additional imports.
+T> `require.resolveWeak` is the foundation of _universal rendering_ (SSR + Code Splitting), as used in packages such as [react-universal-component](https://github.com/faceyspacey/react-universal-component). It allows code to render synchronously on both the server and initial page-loads on the client. It requires that chunks are manually served or somehow available. It's able to require modules without indicating they should be bundled into a chunk. It's used in conjunction with `import()` which takes over when user navigation triggers additional imports.

src/content/api/node.md

@@ -50,7 +50,7 @@ webpack({
 });
 ```
 
-T> The `err` object **will not** include compilation errors and those must be handled separately using `stats.hasErrors()` which will be covered in detail in [Error Handling](#error-handling) section of this guide. The `err` object will only contain webpack-related issues, such as misconfiguration, etc.
+T> The `err` object __will not__ include compilation errors and those must be handled separately using `stats.hasErrors()` which will be covered in detail in [Error Handling](#error-handling) section of this guide. The `err` object will only contain webpack-related issues, such as misconfiguration, etc.
 
 T> You can provide the `webpack` function with an array of configurations. See
 the [MultiCompiler](#multicompiler) section below for more information.
@@ -73,7 +73,7 @@ lifecycle running. It delegates all the loading, bundling, and writing work to
 registered plugins.
 
 The `hooks` property on a `Compiler` instance is used to register a plugin to
-any hook event in the `Compiler`'s lifecycle. The 
+any hook event in the `Compiler`'s lifecycle. The
 [`WebpackOptionsDefaulter`](https://github.com/webpack/webpack/blob/master/lib/WebpackOptionsDefaulter.js)
 and [`WebpackOptionsApply`](https://github.com/webpack/webpack/blob/master/lib/WebpackOptionsApply.js)
 utilities are used by webpack to configure its `Compiler` instance with all the

src/content/branding.md

@@ -5,14 +5,15 @@ contributors:
   - jhnns
   - skipjack
   - rouzbeh84
+  - byzyk
 ---
 
-Here you can find **webpack** project brand guidelines, assets, and license. See our official [media repository](https://github.com/webpack/media) for more information and to find the [license](https://github.com/webpack/media/blob/master/LICENSE) that governs this work. Click any of the images to download them.
+Here you can find __webpack__ project brand guidelines, assets, and license. See our official [media repository](https://github.com/webpack/media) for more information and to find the [license](https://github.com/webpack/media/blob/master/LICENSE) that governs this work. Click any of the images to download them.
 
 
 ## The Name
 
-webpack should **always** be written in lower-case letters, even at the beginning of a sentence.
+webpack should __always__ be written in lower-case letters, even at the beginning of a sentence.
 
 
 ## Logo
@@ -33,12 +34,12 @@ For dark backgrounds, you can use the negative version of the logo:
 
 [svg](https://github.com/webpack/media/blob/master/logo/logo-on-dark-bg.svg) | [png](https://github.com/webpack/media/blob/master/logo/logo-on-dark-bg.png) | [jpg](https://github.com/webpack/media/blob/master/logo/logo-on-dark-bg.jpg)
 
-T> Please use the **icon + text** whenever possible.
+T> Please use the __icon + text__ whenever possible.
 
 
 ## Icon only
 
-**The icon is designed to be used in layout-constrained areas. As previously stated, please prefer icon + text.**
+__The icon is designed to be used in layout-constrained areas. As previously stated, please prefer icon + text.__
 
 <img src="https://raw.githubusercontent.com/webpack/media/master/logo/icon.png" width="250" alt="icon example">
 
@@ -92,4 +93,4 @@ In addition, you can grab the following file types directly from these links:
 
 ## License
 
-The logo and the brand name are **not MIT licensed**. Please check [our LICENSE](https://github.com/webpack/media/blob/master/LICENSE) for usage guidelines.
+The logo and the brand name are __not MIT licensed__. Please check [our LICENSE](https://github.com/webpack/media/blob/master/LICENSE) for usage guidelines.