Merge pull request #35 from wix/docsify-alerts-plugin

adoption of docsify-plugin-flexible-alerts
zivl · Oct 15, 2019 · edb371e · edb371e
2 parents 5ac7892 + 22f5423
commit edb371e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -8,5 +8,5 @@ However, when building tests for your application, you want to assert that the r
 # Sentry Testkit - to the rescue!
 *Sentry Testkit* enables Sentry to work natively in your application, and by overriding the default Sentry transport mechanism, the report is not really sent but rather logged locally into memory. In this way, the logged reports can be fetched later for your own usage, verification, or any other use you may have in your local developing/testing environment.
 
-## Note
-This documentation is for the latest version of sentry-testkit. For v2, please visit [here](https://github.com/wix/sentry-testkit/tree/v2.x/docs/api)
+> [!NOTE]
+> This documentation is for the latest version of `sentry-testkit`. For v2, please visit [here](https://github.com/wix/sentry-testkit/tree/v2.x/docs/api)
diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md
@@ -58,8 +58,8 @@ beforeAll(function(){
 
 You may see more usage examples in the [testing section](https://github.com/wix/sentry-testkit/tree/master/test) of `sentry-testkit` repository as well
 
-## Caveats
-* Pay attention that Sentry reports the events asynchronously.
+> [!TIP]
+> Pay attention that Sentry reports the events asynchronously.
 Even though `captureException` is synchronous function and you can get the `eventId` right away, the reporting itself still goes to an asynchronous flow.
 Hence, it depends what you are testing and the chain of events caused by your test case scenario,
 you will may need to use `async/await` and tools like [`waitForExpect`](https://www.npmjs.com/package/wait-for-expect)
diff --git a/docs/index.html b/docs/index.html
@@ -21,7 +21,7 @@
 </head>
 <body>
   <div id="app"></div>
-  <script src="//unpkg.com/docsify-edit-on-github@1.0.1/index.js"></script>
+    <script src="//unpkg.com/docsify-edit-on-github"></script>
   <script>
     window.$docsify = {
       name: 'Sentry Testkit',
@@ -34,11 +34,15 @@
       ],
       search: 'auto',
       logo: './logo/sentry-testkit-logo.svg',
-      themeColor: '#f47b75'
+      themeColor: '#f47b75',
+      'flexible-alerts': {
+        style: 'callout'
+      }
     }
-  </script>
+    </script>
     <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
-    <script src="//unpkg.com/docsify-copy-code@2"></script>
+    <script src="//unpkg.com/docsify-plugin-flexible-alerts"></script>
+    <script src="//unpkg.com/docsify-copy-code"></script>
     <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
 </body>
 </html>