Merge pull request #6 from janoshrubos/chore/docs-note-styling

triniwiz · web-flow · commit 0183cdd11060 · 2021-10-15T06:22:20.000-07:00
chore(docs): styling notes
diff --git a/packages/firebase-admob/README.md b/packages/firebase-admob/README.md
@@ -94,9 +94,7 @@ A `BannerAd` requires an `unitId`, an `BannerAdSize`, an `AdRequest`, and a `Ban
 
 #### Core
 
-> IMPORTANT
-
-Ensure you've included xmlns:ui="@nativescript/firebase-admob" on the Page element
+> **Important:** Ensure you've included xmlns:ui="@nativescript/firebase-admob" on the Page element
 
 ```xml
 <ui:BannerAd
@@ -271,9 +269,7 @@ Broadly speaking, there are two parts to successfully implementing Native Ads: l
 
 #### Core
 
-> IMPORTANT
-
-Ensure you've included xmlns:ui="@nativescript/firebase-admob" on the Page element
+> **Important:** Ensure you've included `xmlns:ui="@nativescript/firebase-admob"` on the Page element
 
 ```xml
 <ui:NativeAdView height="400" loaded="{{nativeAdLoaded}}" />
diff --git a/packages/firebase-analytics/README.md b/packages/firebase-analytics/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-analytics
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-analytics
 ```
 
diff --git a/packages/firebase-app-check/README.md b/packages/firebase-app-check/README.md
@@ -1,13 +1,11 @@
 # @nativescript/firebase-app-check
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-app-check
 ```
 
 
-**Note**: iOS
-
-App Check requires you set the minimum iOS Deployment version in ios/Podfile to 11.0 or greater.
+> **Note**: (iOS) App Check requires you set the minimum iOS Deployment version in ios/Podfile to 11.0 or greater.
 
 
 ### What does it do
diff --git a/packages/firebase-auth/README.md b/packages/firebase-auth/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-auth
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-auth
 ```
 
@@ -176,9 +176,7 @@ LoginManager.logInWithPermissions(['public_profile', 'email']).then((result) =>
 
 ```
 
-** Note **
-
-> Firebase will not set the User.emailVerified property to true if your user logs in with Facebook. Should your user login using a provider that verifies email (e.g. Google sign-in) then this will be set to true.
+> **Note:** Firebase will not set the User.emailVerified property to true if your user logs in with Facebook. Should your user login using a provider that verifies email (e.g. Google sign-in) then this will be set to true.
 
 #### Twitter
 
@@ -239,7 +237,7 @@ GoogleSignin.signIn().then((user) => {
 
 Phone authentication allows users to sign in to Firebase using their phone as the authenticator. An SMS message is sent to the user (using the provided phone number) containing a unique code. Once the code has been authorized, the user is able to sign into Firebase.
 
-> Phone numbers that end users provide for authentication will be sent and stored by Google to improve spam and abuse prevention across Google service, including to, but not limited to Firebase. Developers should ensure they have the appropriate end-user consent prior to using the Firebase Authentication phone number sign-in service.authentication
+> **Note:** Phone numbers that end users provide for authentication will be sent and stored by Google to improve spam and abuse prevention across Google service, including to, but not limited to Firebase. Developers should ensure they have the appropriate end-user consent prior to using the Firebase Authentication phone number sign-in service.authentication
 
 Firebase Phone Authentication is not supported in all countries. Please see their [FAQs](https://firebase.google.com/support/faq/#develop) for more information.
 
diff --git a/packages/firebase-core/README.md b/packages/firebase-core/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-core
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-core
 ```
 
diff --git a/packages/firebase-crashlytics/README.md b/packages/firebase-crashlytics/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-crashlytics
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-crashlytics
 ```
 
diff --git a/packages/firebase-database/README.md b/packages/firebase-database/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-database
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-database
 ```
 
diff --git a/packages/firebase-firestore/README.md b/packages/firebase-firestore/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-firestore
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-firestore
 ```
 
diff --git a/packages/firebase-functions/README.md b/packages/firebase-functions/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-functions
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-functions
 ```
 
diff --git a/packages/firebase-in-app-messaging/README.md b/packages/firebase-in-app-messaging/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-in-app-messaging
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-in-app-messaging
 ```
 
@@ -30,7 +30,7 @@ According to github issue https://github.com/firebase/firebase-ios-sdk/issues/47
 The isMessagesDisplaySuppressed property allows you to control when messages can/cannot be displayed. Below illustrates a use case for controlling the flow of messages:
 
 
-> **The suppressed state is not persisted between restarts, so ensure it is called as early as possible.**
+> **Note:** The suppressed state is not persisted between restarts, so ensure it is called as early as possible.
 
 
 
diff --git a/packages/firebase-installations/README.md b/packages/firebase-installations/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-installations
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-installations
 ```
 
diff --git a/packages/firebase-messaging/README.md b/packages/firebase-messaging/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-messaging
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-messaging
 ```
 
@@ -70,7 +70,7 @@ Depending on the contents of the message, it's important to understand both how
 
 The device state and message contents determines which handler will be called:
 
-|     Foreground      | Background |                  Quit                   |
+|     Foreground      | Background |                  Quit                   |										   |
 | :-----------------: | :--------: | :-------------------------------------: | --------------------------------------- |
 |    Notification     | onMessage  |       setBackgroundMessageHandler       | setBackgroundMessageHandler             |
 | Notification + Data | onMessage  |       setBackgroundMessageHandler       | setBackgroundMessageHandler             |
@@ -86,7 +86,7 @@ To learn more about how to send these options in your message payload, view the
 
 The device state and message contents can also determine whether a Notification will be displayed:
 
-|     Foreground      |    Background    |       Quit       |
+|     Foreground      |    Background    |       Quit       |				|
 | :-----------------: | :--------------: | :--------------: | ---------------- |
 |    Notification     | Notification: ❌ | Notification: ✅ | Notification: ✅ |
 | Notification + Data | Notification: ❌ | Notification: ✅ | Notification: ✅ |
@@ -222,7 +222,7 @@ To send a message to a device, you must access its unique token. A token is auto
 
 The examples below use a Cloud Firestore database to store and manage the tokens, and Firebase Authentication to manage the users identity. You can however use any datastore or authentication method of your choice.
 
-> If using iOS, ensure you have completed the [setup](#apple-integration) & [requested user permission](#iOS---Requesting-permissions) before trying to receive messages!
+> **Note:** If using iOS, ensure you have completed the [setup](#apple-integration) & [requested user permission](#iOS---Requesting-permissions) before trying to receive messages!
 
 ### Saving tokens
 
@@ -277,7 +277,7 @@ Inside of the saveTokenToDatabase method, we store the token on a record specifi
 
 With the tokens stored in a secure datastore, we now have the ability to send messages via FCM to those devices.
 
-> The following example uses the Node.JS firebase-admin package to send messages to our devices, however any SDK (listed above) can be used.
+> **Note:** The following example uses the Node.JS firebase-admin package to send messages to our devices, however any SDK (listed above) can be used.
 
 Go ahead and setup the `firebase-tools` library on your server environment. Once setup, our script needs to perform two actions:
 
@@ -415,7 +415,7 @@ const payload = {
 };
 ```
 
-> Check out the [official Firebase documentation](https://firebase.google.com/docs/cloud-messaging/ios/send-image) to see the list of available configuration for iOS.
+> **Note:** Check out the [official Firebase documentation](https://firebase.google.com/docs/cloud-messaging/ios/send-image) to see the list of available configuration for iOS.
 
 #### Android
 
@@ -435,7 +435,7 @@ const payload = {
 };
 ```
 
-> If you want to know more about sending an image on Android have a look at [the documentation](https://firebase.google.com/docs/cloud-messaging/android/send-image).
+> **Note:** If you want to know more about sending an image on Android have a look at [the documentation](https://firebase.google.com/docs/cloud-messaging/android/send-image).
 
 ### Pulling it all together
 
@@ -502,7 +502,7 @@ If you want to use a specific icon for the push notification, it has to be confi
 Open /platforms/ios/yourproject.**xcworkspace** (!) and go to your project's target and head over to "Capabilities" to switch this on (if it isn't already):
 ![push-xcode-config](https://raw.githubusercontent.com/NativeScript/firebase/main/packages/firebase-messaging/assets/images/push-xcode-config.png)
 
-> Without this enabled you will receive push messages in the foreground, but **NOT in the background** / when the app is killed.
+> **Note:** Without this enabled you will receive push messages in the foreground, but **NOT in the background** / when the app is killed.
 
 #### Copy the entitlements file
 
diff --git a/packages/firebase-remote-config/README.md b/packages/firebase-remote-config/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-remote-config
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-remote-config
 ```
 
diff --git a/packages/firebase-storage/README.md b/packages/firebase-storage/README.md
@@ -1,6 +1,6 @@
 # @nativescript/firebase-storage
 
-```javascript
+```cli
 ns plugin add @nativescript/firebase-storage
 ```
 
