style: format markdown files for consistency

loopbackio · Mar 27, 2018 · d2daf38 · d2daf38
1 parent 2e4c8bc
commit d2daf38
Show file tree

Hide file tree

Showing 86 changed files with 3,912 additions and 2,722 deletions.
diff --git a/README.md b/README.md
@@ -2,24 +2,30 @@
 
 [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/strongloop/loopback) [![Travis Build Status](https://travis-ci.org/strongloop/loopback-next.svg?branch=master)](https://travis-ci.org/strongloop/loopback-next) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/3v1qmusv168a0kb0/branch/master?svg=true)](https://ci.appveyor.com/project/bajtos/loopback-next/branch/master) [![Coverage Status](https://coveralls.io/repos/github/strongloop/loopback-next/badge.svg?branch=master)](https://coveralls.io/github/strongloop/loopback-next?branch=master)
 
-LoopBack makes it easy to build modern applications that require complex integrations.
+LoopBack makes it easy to build modern applications that require complex
+integrations.
 
 - Fast, small, powerful, extensible core
 - Generate real APIs with a single command
 - Define your data and endpoints with OpenAPI
 - No maintenance of generated code
 
-# Status: Developer Preview #1
+## Status: Developer Preview #1
 
 LoopBack 4 is a work in progress, the public API is frequently changed in
-backward incompatible ways. See [Upcoming-Releases on wiki](https://github.com/strongloop/loopback-next/wiki/Upcoming-Releases)
+backward incompatible ways. See
+[Upcoming-Releases on wiki](https://github.com/strongloop/loopback-next/wiki/Upcoming-Releases)
 for more details.
 
-Learn about the latest and greatest [features and technologies in LoopBack 4](https://loopback.io/doc/en/lb4/Crafting-LoopBack-4.html) by using it for your next project. Start by having a look at [Getting Started](https://loopback.io/doc/en/lb4/Getting-started.html).
+Learn about the latest and greatest
+[features and technologies in LoopBack 4](https://loopback.io/doc/en/lb4/Crafting-LoopBack-4.html)
+by using it for your next project. Start by having a look at
+[Getting Started](https://loopback.io/doc/en/lb4/Getting-started.html).
 
-**NOTE:** _It is not recommended for production use yet._ For production, use [LoopBack 3](https://loopback.io/doc/en/lb3/index.html).
+**NOTE:** _It is not recommended for production use yet._ For production, use
+[LoopBack 3](https://loopback.io/doc/en/lb3/index.html).
 
-# Installation
+## Installation
 
 Make sure you have the following installed:
 
@@ -31,55 +37,66 @@ Install LoopBack 4 CLI to help create new projects as follows:
 npm i -g @loopback/cli
 ```
 
-To create your first LoopBack 4 application, see [Getting Started](http://loopback.io/doc/en/lb4/Getting-started.html).
+To create your first LoopBack 4 application, see
+[Getting Started](http://loopback.io/doc/en/lb4/Getting-started.html).
 
-# Documentation
+## Documentation
 
 - [Official documentation](http://loopback.io/doc/en/lb4/)
 - [API documentation](http://apidocs.loopback.io/#LoopBack4)
 - [FAQ](http://loopback.io/doc/en/lb4/FAQ.html)
 - [LoopBack 3 vs LoopBack 4](http://loopback.io/doc/en/lb4/LoopBack-3.x.html)
 - [Tutorials and examples](http://loopback.io/doc/en/lb4/Examples-and-tutorials.html)
 
-# Contributing
+## Contributing
 
 See the following resources to get your started:
 
- - [Contributing Guidelines](./docs/CONTRIBUTING.md)
- - [Monorepo overview](./docs/site/MONOREPO.md)
- - [Developing LoopBack](./docs/site/DEVELOPING.md)
+- [Contributing Guidelines](./docs/CONTRIBUTING.md)
+- [Monorepo overview](./docs/site/MONOREPO.md)
+- [Developing LoopBack](./docs/site/DEVELOPING.md)
 
-You can join the team by posting a comment to [issue #110](https://github.com/strongloop/loopback-next/issues/110).
+You can join the team by posting a comment to
+[issue #110](https://github.com/strongloop/loopback-next/issues/110).
 
-# Team
+## Team
 
-## Project Architects:
+### Project Architects
 
-Raymond Feng|Miroslav Bajtos|Ritchie Martori
-:-:|:-:|:-:
-[![raymondfeng]](http://github.com/raymondfeng)|[![bajtos]](http://github.com/bajtos)|[![ritch]](http://github.com/ritch)
+|                   Raymond Feng                  |            Miroslav Bajtos            |           Ritchie Martori           |
+| :---------------------------------------------: | :-----------------------------------: | :---------------------------------: |
+| [![raymondfeng]](http://github.com/raymondfeng) | [![bajtos]](http://github.com/bajtos) | [![ritch]](http://github.com/ritch) |
 
-## Project Maintainers:
+### Project Maintainers
 
-|||||
-|:-:|:-:|:-:|:-:|
-|Taranveer Virk|Biniam Admikew|Kyu Shim|Diana Lau|
-|[![virkt25]](http://github.com/virkt25)|[![b-admike]](http://github.com/b-admike)|[<img src="https://avatars3.githubusercontent.com/u/18518689?v=3&s=60" height=60>](http://github.com/shimks)|[![dhmlau]](http://github.com/dhmlau)|
-|Janny Hou|Simon Ho|Kevin Delisle|Rand McKinney|
-|[![jannyhou]](http://github.com/jannyHou)|[![superkhau]](http://github.com/superkhau)|
+|                                           |                                             |                                                                                                              |                                       |
+| :---------------------------------------: | :-----------------------------------------: | :----------------------------------------------------------------------------------------------------------: | :-----------------------------------: |
+|               Taranveer Virk              |                Biniam Admikew               |                                                   Kyu Shim                                                   |               Diana Lau               |
+|  [![virkt25]](http://github.com/virkt25)  |  [![b-admike]](http://github.com/b-admike)  | [<img src="https://avatars3.githubusercontent.com/u/18518689?v=3&s=60" height=60>](http://github.com/shimks) | [![dhmlau]](http://github.com/dhmlau) |
+|                 Janny Hou                 |                   Simon Ho                  |                                                                                                              |                                       |
+| [![jannyhou]](http://github.com/jannyHou) | [![superkhau]](http://github.com/superkhau) |                                                                                                              |                                       |
 
-See [all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).
+See
+[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).
 
-# License
+## License
 
 [MIT](LICENSE)
 
 [raymondfeng]: https://avatars0.githubusercontent.com/u/540892?v=3&s=60
+
 [bajtos]: https://avatars2.githubusercontent.com/u/1140553?v=3&s=60
+
 [ritch]: https://avatars2.githubusercontent.com/u/462228?v=3&s=60
+
 [b-admike]: https://avatars0.githubusercontent.com/u/13950637?v=3&s=60
+
 [dhmlau]: https://avatars2.githubusercontent.com/u/25489897?v=3&s=60
+
 [jannyhou]: https://avatars2.githubusercontent.com/u/12554153?v=3&s=60
+
 [superkhau]: https://avatars1.githubusercontent.com/u/1617364?v=3&s=60
+
 [loay]: https://avatars3.githubusercontent.com/u/1986928?v=3&s=60
+
 [virkt25]: https://avatars1.githubusercontent.com/u/3311536?v=3&s=60
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -1,41 +1,54 @@
 # Contributing to LoopBack
 
-Contributions to LoopBack include code, documentation, answering user questions, and advocating for all types of LoopBack users. See our official documentation on loopback.io for more information common to all of our GitHub repositories:
+Contributions to LoopBack include code, documentation, answering user questions,
+and advocating for all types of LoopBack users. See our official documentation
+on loopback.io for more information common to all of our GitHub repositories:
 
-  - http://loopback.io/doc/en/contrib/index.html
+- <http://loopback.io/doc/en/contrib/index.html>
 
 ## [Principles](http://loopback.io/doc/en/contrib/Governance.html#principles)
 
-LoopBack is an open, inclusive, and tolerant community of people working together to build a world-class Node framework and tools. We value diversity of individuals and opinions, and seek to operate on consensus whenever possible. We strive to maintain a welcoming, inclusive, and harassment-free environment, regardless of the form of communication. When consensus is not achievable, we defer to the owners of each individual module; the powers of the individual owner are kept in check by the ability of the community to fork and replace dependencies on the individual module and maintainer.
+LoopBack is an open, inclusive, and tolerant community of people working
+together to build a world-class Node framework and tools. We value diversity of
+individuals and opinions, and seek to operate on consensus whenever possible. We
+strive to maintain a welcoming, inclusive, and harassment-free environment,
+regardless of the form of communication. When consensus is not achievable, we
+defer to the owners of each individual module; the powers of the individual
+owner are kept in check by the ability of the community to fork and replace
+dependencies on the individual module and maintainer.
 
 ## [Reporting issues](http://loopback.io/doc/en/contrib/Reporting-issues.html)
 
-Issues in [strongloop/loopback-next](https://github.com/strongloop/loopback-next/issues) are the primary means by which bug reports and general discussions are made.
+Issues in
+[strongloop/loopback-next](https://github.com/strongloop/loopback-next/issues)
+are the primary means by which bug reports and general discussions are made.
 
- - [How to report an issue](http://loopback.io/doc/en/contrib/Reporting-issues.html#how-to-report-an-issue)
- - [Disclosing security vulnerabilities](http://loopback.io/doc/en/contrib/Reporting-issues.html#security-issues)
+- [How to report an issue](http://loopback.io/doc/en/contrib/Reporting-issues.html#how-to-report-an-issue)
+- [Disclosing security vulnerabilities](http://loopback.io/doc/en/contrib/Reporting-issues.html#security-issues)
 
 ## [Contributing code](http://loopback.io/doc/en/contrib/code-contrib.html)
 
-Pull Requests are the way concrete changes are made to the code, documentation and tools contained in LoopBack repositories.
+Pull Requests are the way concrete changes are made to the code, documentation
+and tools contained in LoopBack repositories.
 
- - [Monorepo overview](./site/MONOREPO.md)
- - [Setting up development environment](./site/DEVELOPING.md#setting-up-development-environment)
- - [How to contribute the code](http://loopback.io/doc/en/contrib/code-contrib.html#how-to-contribute-to-the-code)
- - [Building the project](./site/DEVELOPING.md#building-the-project)
- - [Running tests](./site/DEVELOPING.md#running-tests)
- - [Coding rules](./site/DEVELOPING.md#coding-rules)
- - [API documentation](./site/DEVELOPING.md#api-documentation)
- - [Git commit messages](./site/DEVELOPING.md#commit-message-guidelines)
- - [Reviewing pull requests](http://loopback.io/doc/en/contrib/triaging-pull-requests.html)
- - [Contributor License Agreement (CLA)](http://loopback.io/doc/en/contrib/code-contrib.html#agreeing-to-the-cla)
+- [Monorepo overview](./site/MONOREPO.md)
+- [Setting up development environment](./site/DEVELOPING.md#setting-up-development-environment)
+- [How to contribute the code](http://loopback.io/doc/en/contrib/code-contrib.html#how-to-contribute-to-the-code)
+- [Building the project](./site/DEVELOPING.md#building-the-project)
+- [Running tests](./site/DEVELOPING.md#running-tests)
+- [Coding rules](./site/DEVELOPING.md#coding-rules)
+- [API documentation](./site/DEVELOPING.md#api-documentation)
+- [Git commit messages](./site/DEVELOPING.md#commit-message-guidelines)
+- [Reviewing pull requests](http://loopback.io/doc/en/contrib/triaging-pull-requests.html)
+- [Contributor License Agreement (CLA)](http://loopback.io/doc/en/contrib/code-contrib.html#agreeing-to-the-cla)
 
 ## [Documentation](http://loopback.io/doc/en/contrib/doc-contrib.html)
 
-LoopBack documentation is sourced in the [strongloop/loopback.io](https://github.com/strongloop/loopback.io) GitHub repository.
-
- - [How LoopBack documentation works](http://loopback.io/doc/en/contrib/doc-contrib.html#how-loopback-documentation-works)
- - [Using Jekyll](http://loopback.io/doc/en/contrib/jekyll_getting_started.html)
- - [Authoring pages](http://loopback.io/doc/en/contrib/pages.html)
- - [Translations](http://loopback.io/doc/en/contrib/translation.html)
+LoopBack documentation is sourced in the
+[strongloop/loopback.io](https://github.com/strongloop/loopback.io) GitHub
+repository.
 
+- [How LoopBack documentation works](http://loopback.io/doc/en/contrib/doc-contrib.html#how-loopback-documentation-works)
+- [Using Jekyll](http://loopback.io/doc/en/contrib/jekyll_getting_started.html)
+- [Authoring pages](http://loopback.io/doc/en/contrib/pages.html)
+- [Translations](http://loopback.io/doc/en/contrib/translation.html)
diff --git a/docs/site/Application-generator.md b/docs/site/Application-generator.md
@@ -12,59 +12,55 @@ summary:
 
 Creates a new LoopBack4 application using REST API.
 
-```
+```sh
 lb4 [app] [options] [<name>]
 ```
 
 ### Options
 
-`--applicationName`
-: Application name.
+`--applicationName` : Application name.
 
-`--description`
-: Description of the application.
+`--description` : Description of the application.
 
-`--outDir`
-: Project root directory for the application.
+`--outDir` : Project root directory for the application.
 
-`--tslint`
-: Add TSLint to LoopBack4 application project.
+`--tslint` : Add TSLint to LoopBack4 application project.
 
-`--prettier`
-: Add Prettier to LoopBack4 application project.
+`--prettier` : Add Prettier to LoopBack4 application project.
 
-`--mocha`
-: Add Mocha to LoopBack4 application project.
+`--mocha` : Add Mocha to LoopBack4 application project.
 
-`--loopbackBuild`
-: Add @loopback/build module's script set to LoopBack4 application project.
+`--loopbackBuild` : Add @loopback/build module's script set to LoopBack4
+application project.
 
 {% include_relative includes/CLI-std-options.md %}
 
 ### Arguments
 
-`<name>` - Optional name of the application given as an argument to the command. 
-If provided, the tool will use that as the default when prompting for the name.
+`<name>` - Optional name of the application given as an argument to the
+command.  If provided, the tool will use that as the default when prompting for
+the name.
 
 ### Interactive Prompts
 
 The tool will prompt you for:
 
-- Name of the application as will be shown in `package.json`.
-If the name had been supplied from the command-line, the prompt is skipped and the application is built with the name from the command-line argument.
-Must follow npm naming conventions.
+- Name of the application as will be shown in `package.json`. If the name had
+  been supplied from the command-line, the prompt is skipped and the application
+  is built with the name from the command-line argument. Must follow npm naming
+  conventions.
 
 - Description of the application as will be shown in `package.json`.
 
-- Name of the directory in which to create your application.
-Defaults to the name of the application previously entered.
+- Name of the directory in which to create your application. Defaults to the
+  name of the application previously entered.
 
-- Name of the Application class in `application.ts`.
-Defaults to <code><i>name</i>Application</code>.
+- Name of the Application class in `application.ts`. Defaults to
+  <code><i>name</i>Application</code>.
 
-- Optional modules to add to the application. These modules are helpful tools to help format, test, and build a LoopBack4 application.
-Defaults to `true` for all of the modules.
-The prompted modules are:
+- Optional modules to add to the application. These modules are helpful tools to
+  help format, test, and build a LoopBack4 application. Defaults to `true` for
+  all of the modules. The prompted modules are:
 
   - [`tslint`](https://www.npmjs.com/package/tslint)
   - [`prettier`](https://www.npmjs.com/package/prettier)
@@ -73,9 +69,10 @@ The prompted modules are:
 
 ### Output
 
-The core scaffold of a LoopBack4 application generated by the CLI consists of the following files and directories:
+The core scaffold of a LoopBack4 application generated by the CLI consists of
+the following files and directories:
 
-```
+```text
 .
 ├── src/
 |   ├── controllers/
@@ -90,10 +87,14 @@ The core scaffold of a LoopBack4 application generated by the CLI consists of th
 └── package.json
 ```
 
-`ping.controller.ts` is a file used to provide the application with a responsive endpoint.
-It contains logic to respond with a greeting message when the appliaction receives a `GET` request from endpoint `/ping`.
+`ping.controller.ts` is a file used to provide the application with a responsive
+endpoint. It contains logic to respond with a greeting message when the
+appliaction receives a `GET` request from endpoint `/ping`.
 
-`cd` to the application's newly created directory and run `npm start` to see the application running at `localhost:3000`.
-Go to `localhost:3000/ping` to be greeted with a message.
+`cd` to the application's newly created directory and run `npm start` to see the
+application running at `localhost:3000`. Go to `localhost:3000/ping` to be
+greeted with a message.
 
-Once the application has been created, additional generators such as [controller generator](Controller-generator.md) can be run from the application's root directory to further scaffold the application.
+Once the application has been created, additional generators such as
+[controller generator](Controller-generator.md) can be run from the
+application's root directory to further scaffold the application.