Docs: fix GitHub format (#12682)
* Docs: fix GitHub format Github -> GitHub github -> GitHub * Apply suggestions from code review Co-authored-by: Tina Luedtke <kickoke@users.noreply.github.com>
Ikko Ashimine committed
Apr 20, 2022 at 20:22 UTC
fce09f9c899f10c5d39125c93b111b3fc4b7aaa6
1 file changed
+6
-4
web/api/badges/README.md
+6
-4
@@ -324,9 +324,11 @@ On modern hardware, Netdata can generate about **2.000 badges per second per cor
324
325
Of course these timing are for badges that use recent data. If you need badges that do calculations over long durations (a day, or more), timing will differ. Netdata logs its timings at its `access.log`, so take a look there before adding a heavy badge on a busy web site. Of course, you can cache such badges or have a cron job get them from Netdata and save them at your web server at regular intervals.
326
327
-#### Embedding badges in github
327
+#### Embedding badges in GitHub
328
329
-You have 2 options a) SVG images with markdown and b) SVG images with HTML (directly in .md files).
329
+You have 2 options:
330
+- SVG images with markdown
331
+- SVG images with HTML (directly in .md files)
332
333
For example, this is the cpu badge shown above:
334
@@ -350,9 +352,9 @@ Both produce this:
352
<img src="https://registry.my-netdata.io/api/v1/badge.svg?chart=users.cpu&dimensions=root&value_color=grey:null%7Cgreen%3C10%7Cyellow%3C20%7Corange%3C50%7Cblue%3C100%7Cred&label=root%20user%20cpu%20now&units=%25"></img>
353
</a>
354
353
-#### auto-refreshing badges in github
355
+#### Auto-refreshing badges in GitHub
356
355
-Unfortunately it cannot be done. Github fetches all the images using a proxy and rewrites all the URLs to be served by the proxy.
357
+Unfortunately it cannot be done. GitHub fetches all the images using a proxy and rewrites all the URLs to be served by the proxy.
358
359
You can refresh them from your browser console though. Press F12 to open the web browser console (switch to the console too), paste the following and press enter. They will refresh:
360