chore(docs): plugins styling notes (#183)

janoshrubos · web-flow · commit 72c275c30465 · 2021-10-16T09:06:09.000-07:00
diff --git a/packages/animated-circle/README.md b/packages/animated-circle/README.md
@@ -61,8 +61,4 @@ imports: [NativeScriptAnimatedCircleModule];
 
 ## License
 
-Apache License Version 2.0
-
-```
-
-```
+Apache License Version 2.0
diff --git a/packages/appavailability/README.md b/packages/appavailability/README.md
@@ -8,7 +8,7 @@ ns plugin add @nativescript/appavailability
 
 ## Usage
 
-> Note that version 1.3.0 added a synchronous version of this method that doesn't return a Promise. Need that? Use `availableSync` instead of `available`.
+> **Note:** Version 1.3.0 added a synchronous version of this method that doesn't return a Promise. Need that? Use `availableSync` instead of `available`.
 
 ### TypeScript
 
diff --git a/packages/background-http/README.md b/packages/background-http/README.md
@@ -151,7 +151,7 @@ node server 8080
 
 The above commands will start a server listening on port 8080. Remember to update the URL in your app to match the address/port where the server is running.
 
-> Note: If you are using the iOS simulator then `http://localhost:8080` should be used to upload to the demo server. If you are using an Android emulator, `http://10.0.2.2:8080` should be used instead.
+> **Note**: If you are using the iOS simulator then `http://localhost:8080` should be used to upload to the demo server. If you are using an Android emulator, `http://10.0.2.2:8080` should be used instead.
 
 ## License
 
diff --git a/packages/brightness/README.md b/packages/brightness/README.md
@@ -6,7 +6,7 @@ ns plugin add @nativescript/brightness
 
 This command automatically installs the necessary files, as well as stores @nativescript/brightness as a dependency in your project's `package.json` file.
 
-This plugin requires `<uses-permission android:name="android.permission.WRITE_SETTINGS"/>` to be added in the android manifest.
+> **Note:** This plugin requires `<uses-permission android:name="android.permission.WRITE_SETTINGS"/>` to be added in the android manifest.
 
 ## Usage
 
diff --git a/packages/camera/README.md b/packages/camera/README.md
@@ -37,7 +37,7 @@ npm install @nativescript/camera --save
 | cameraFacing    | rear    | Both     | The initial camera facing. Use `'front'` for selfies.                                                                                                                                                                                                                                                                                                                                    |
 | modalPresentationStyle    | 0    | iOS     | Set a custom UIModalPresentationStyle (Defaults to UIModalPresentationStyle.FullScreen)                                                                                                                                                                                                                                                                                                                                   |
 
-> Note: The `saveToGallery` option might have unexpected behavior on Android! Some vendor camera apps (e.g. LG) will save all captured images to the gallery regardless of what the value of `saveToGallery` is. This behavior cannot be controlled by the camera plugin and if you must exclude the captured image from the photo gallery, you will need to get a local storage read/write permission and write custom code to find the gallery location and delete the new image from there.
+> **Note**: The `saveToGallery` option might have unexpected behavior on Android! Some vendor camera apps (e.g. LG) will save all captured images to the gallery regardless of what the value of `saveToGallery` is. This behavior cannot be controlled by the camera plugin and if you must exclude the captured image from the photo gallery, you will need to get a local storage read/write permission and write custom code to find the gallery location and delete the new image from there.
 
 ## Usage
 
@@ -59,10 +59,9 @@ requestPermissions().then(
     }
 );
 ```
+> **Note:** (**for Android**) Older versions of Android that don't use a request permissions popup won't be affected by the usage of the requestPermissions method.
 
-> **Note for Android:** Older versions of Android that don't use a request permissions popup won't be affected by the usage of the requestPermissions method.
-
-> **Note for iOS:** If the user rejects permissions from the iOS popup, the app is not allowed to ask again. You can instruct the user to go to app settings and enable the camera permission manually from there. Additionally, [App Store Guideline 5.1.1](https://developer.apple.com/app-store/review/guidelines/#data-collection-and-storage) requires apps to clarify the usage of the camera and photo library. To do so, edit your `app/App_Resources/iOS/Info.plist` and add the following clarifications:
+> **Note**: (**for iOS**) If the user rejects permissions from the iOS popup, the app is not allowed to ask again. You can instruct the user to go to app settings and enable the camera permission manually from there. Additionally, [App Store Guideline 5.1.1](https://developer.apple.com/app-store/review/guidelines/#data-collection-and-storage) requires apps to clarify the usage of the camera and photo library. To do so, edit your `app/App_Resources/iOS/Info.plist` and add the following clarifications:
 
 ```
 <key>NSCameraUsageDescription</key>
@@ -78,7 +77,7 @@ However, there are some points that need a little bit more explanation.
 
 In order to use the camera module, just require it, as shown in Example 1:
 
-> Example 1: Require camera module in the application
+#### Example 1: Require camera module in the application
 
 ```JavaScript
 // JavaScript
@@ -92,7 +91,7 @@ import * as camera from "@nativescript/camera";
 
 Then you are ready to use it:
 
-> Example 2: How to take a picture and to receive image asset
+#### Example 2: How to take a picture and to receive image asset
 
 ```JavaScript
 // JavaScript
@@ -140,7 +139,7 @@ Setting the `keepAspectRatio` property could result in a different than requeste
 
 **Example 3** shows how to use the options parameter:
 
-> Example 3: How to setup `width`, `height`, `keepAspectRatio` and `saveToGallery` properties for the camera module
+#### Example 3: How to setup `width`, `height`, `keepAspectRatio` and `saveToGallery` properties for the camera module
 
 ```JavaScript
 // JavaScript
@@ -218,4 +217,4 @@ The method isAvaiable will return true if the camera hardware is ready to use or
 const isAvailable = camera.isAvailable();
 ```
 
-> Note: This method will return false when used in iOS simulator (as the simulator does not have camera hardware)
+> **Note**: This method will return false when used in iOS simulator (as the simulator does not have camera hardware)
diff --git a/packages/detox/README.md b/packages/detox/README.md
@@ -116,7 +116,7 @@ Here is a full example of a Detox configuration:
 }
 ```
 
-**NOTE:** A default NativeScript Android project uses 17 as the minimum SDK, but Detox requires >=18. Remove or modify the `minSdkVersion` in your `App_Resources/Android/app.gradle`.
+> **Note:** A default NativeScript Android project uses 17 as the minimum SDK, but Detox requires >=18. Remove or modify the `minSdkVersion` in your `App_Resources/Android/app.gradle`.
 
 ## Usage
 
diff --git a/packages/email/README.md b/packages/email/README.md
@@ -13,7 +13,7 @@
 
 You can use this plugin to compose an e-mail, have the user edit the draft manually, and send it.
 
-> Note that this plugin depends on the default mail app. If you want a fallback to a third party client app like Gmail or Outlook, then check for availability, and if not available use a solution like [the Social Share plugin](https://github.com/tjvantoll/nativescript-social-share).
+> **Note:** This plugin depends on the default mail app. If you want a fallback to a third party client app like Gmail or Outlook, then check for availability, and if not available use a solution like [the Social Share plugin](https://github.com/tjvantoll/nativescript-social-share).
 
 ```cli
 ns plugin add @nativescript/email
diff --git a/packages/fingerprint-auth/README.md b/packages/fingerprint-auth/README.md
@@ -91,7 +91,7 @@ If you want to override the default texts of this popover screen, then drop a fi
 
 **Use plugin version < 7.0.0 to be able to use this feature with NativeScript < 5.4.0**
 
-> Skip this section if you're on NativeScript 5.4.0 or newer because it's all handled automatically!
+> **Note**: Skip this section if you're on NativeScript 5.4.0 or newer because it's all handled automatically!
 
 To be able to use this screen, a change to `App_Resources/Android/AndroidManifest.xml` is required as our NativeScript activity needs to extend AppCompatActivity (note that in the future this may become the default for NativeScript apps).
 
diff --git a/packages/geolocation/README.md b/packages/geolocation/README.md
@@ -71,14 +71,14 @@ geolocation.getCurrentLocation({ desiredAccuracy: Accuracy.high, maximumAge: 500
 | iosAllowsBackgroundLocationUpdates    | false         | If enabled, UIBackgroundModes key in info.plist is required (check the hint below). Allow the application to receive location updates in background (ignored on Android). Read more in [Apple document](https://developer.apple.com/documentation/corelocation/cllocationmanager/1620568-allowsbackgroundlocationupdates?language=objc)                                                     |
 | iosPausesLocationUpdatesAutomatically | true          | Allow deactivation of the automatic pause of location updates (ignored on Android). Read more in [Apple document](https://developer.apple.com/documentation/corelocation/cllocationmanager/1620553-pauseslocationupdatesautomatical?language=objc)                                                                                                                                          |
 
-> If iosAllowsBackgroundLocationUpdates is set to true, the following code is required in the info.plist file:
->
-> ```
-> <key>UIBackgroundModes</key>
-> <array>
->    <string>location</string>
-> </array>
-> ```
+> **Note**: If `iosAllowsBackgroundLocationUpdates` is set to true, the following code is required in the `info.plist` file:
+
+```
+<key>UIBackgroundModes</key>
+<array>
+  <string>location</string>
+</array>
+```
 
 ### Methods
 
diff --git a/packages/localize/README.md b/packages/localize/README.md
@@ -193,16 +193,16 @@ Keys starting with `ios.info.plist.` are used to localize iOS properties:
 
 This plugin uses the native capabilities of each platform, language selection is therefore made by the OS.
 
-## On iOS you can programmatically override this language since plugin version 4.2.0 by doing this:
+#### On iOS you can programmatically override this language since plugin version 4.2.0 by doing this:
 
 ```typescript
 import { overrideLocale } from '@nativescript/localize';
 const localeOverriddenSuccessfully = overrideLocale('en-GB'); // or "nl-NL", etc (or even just the part before the hyphen)
 ```
 
-## On Android you can programatically override this language since plugin version 4.2.1 by doing this:
+#### On Android you can programatically override this language since plugin version 4.2.1 by doing this:
 
-In your app.ts / main.ts / app.js
+In your `app.ts` / `main.ts` / `app.js`
 
 ```ts
 import { Application } from '@nativescript/core';
@@ -244,8 +244,7 @@ alert({
 });
 ```
 
-> **Important:** In case you are using [Android app bundle](https://docs.nativescript.org/tooling/publishing/android-app-bundle) to release your android app, add this to
-> App_Resources/Android/app.gradle to make sure all lanugages are bundled in the split apks
+> **Important:** In case you are using [Android app bundle](https://docs.nativescript.org/tooling/publishing/android-app-bundle) to release your android app, add this to `App_Resources/Android/app.gradle` to make sure all lanugages are bundled in the split apks
 
 ```groovy
 android {
@@ -268,8 +267,7 @@ import { Device } from '@nativescript/core';
 console.log("user's language is", Device.language.split('-')[0]);
 ```
 
-> **Tip:** overrideLocale method stores the language in a special key in app-settings,
-> you can access it like this,
+> **Tip:** overrideLocale method stores the language in a special key in app-settings, you can access it like this
 
 ```ts
 import { ApplicationSettings } from '@nativescript/core';

Original file line number	Diff line number	Diff line change
`@@ -116,7 +116,7 @@ Here is a full example of a Detox configuration:`
`116`	`116`	`}`
`117`	`117`	```
`118`	`118`
`119`		-NOTE: A default NativeScript Android project uses 17 as the minimum SDK, but Detox requires >=18. Remove or modify the `minSdkVersion` in your `App_Resources/Android/app.gradle`.
	`119`	+> Note: A default NativeScript Android project uses 17 as the minimum SDK, but Detox requires >=18. Remove or modify the `minSdkVersion` in your `App_Resources/Android/app.gradle`.
`120`	`120`
`121`	`121`	`## Usage`
`122`	`122`