markdown consistency fixes

.github/ISSUE_TEMPLATE/bug-report.md

@@ -7,23 +7,23 @@ assignees: ''
 
 ---
 
-**bug description**
+# bug description
 a clear and concise description of what the bug is.
 
-**reproduction steps**
+# reproduction steps
 steps to reproduce the behavior:
 1. go to '...'
 2. click on '....'
 3. download this video: **[link here]**
 4. see error
 
-**screenshots**
+# screenshots
 if applicable, add screenshots or screen recordings to help explain your problem.
 
-**links**
+# links
 if applicable, add links that cause the issue. more = better.
 
-**platform**
+# platform
 - OS [e.g. iOS, windows]
 - browser [e.g. chrome, safari, firefox]
 - version [e.g. 115]

.github/ISSUE_TEMPLATE/feature-request.md

@@ -7,11 +7,11 @@ assignees: ''
 
 ---
 
-**describe the feature you'd like to see**
+# describe the feature you'd like to see
 a clear and concise description of what you want to happen.
 
-**describe alternatives you've considered**
+# describe alternatives you've considered
 a clear and concise description of any alternative solutions or features you've considered.
 
-**additional context**
+# additional context
 add any other context or screenshots about the feature request here.

README.md

@@ -1,10 +1,10 @@
 # cobalt
-best way to save what you love: [cobalt.tools](https://cobalt.tools/)  
+best way to save what you love: [cobalt.tools](https://cobalt.tools/)
 
-![cobalt logo with repeated logo (double arrow) pattern background](https://raw.githubusercontent.com/wukko/cobalt/current/src/front/icons/pattern.png "cobalt logo with repeated logo (double arrow) pattern background")  
+![cobalt logo with repeated logo (double arrow) pattern background](https://raw.githubusercontent.com/wukko/cobalt/current/src/front/icons/pattern.png "cobalt logo with repeated logo (double arrow) pattern background")
 
 ## what's cobalt?
-cobalt is a media downloader that doesn't piss you off. it's fast, friendly, and doesn't have any bullshit that modern web is filled with: ***no ads, trackers, or analytics***.  
+cobalt is a media downloader that doesn't piss you off. it's fast, friendly, and doesn't have any bullshit that modern web is filled with: ***no ads, trackers, or analytics***.
 
 paste the link, get the file, move on. it's that simple. just how it should be.
 
@@ -50,16 +50,17 @@ this list is not final and keeps expanding over time. if support for a service y
 | youtube    | supports videos, music, and shorts. 8K, 4K, HDR, VR, and high FPS videos. rich metadata & dubs. h264/av1/vp9 codecs. |
 
 ## cobalt api
-cobalt has an open api that you can use in projects *for completely free~*. it's easy and straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/api.md) to learn how to use it. 
+cobalt has an open api that you can use in projects *for completely free~*. it's easy and straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/api.md) to learn how to use it.
 
 you can use the main api instance ([co.wuk.sh](https://co.wuk.sh/)) in your projects.
 
 ## how to run your own instance
-if you want to run your own instance for whatever purpose, [follow this guide](https://github.com/wukko/cobalt/blob/current/docs/run-an-instance.md).  
+if you want to run your own instance for whatever purpose, [follow this guide](https://github.com/wukko/cobalt/blob/current/docs/run-an-instance.md).
+
 it's *highly* recommended to use a docker compose method unless you run for developing/debugging purposes.
 
-## sponsors 
+## sponsors
-cobalt is sponsored by [royalehosting.net](https://royalehosting.net/), all main instances are currently hosted on their network :)  
+cobalt is sponsored by [royalehosting.net](https://royalehosting.net/), all main instances are currently hosted on their network :)
 
 ## ethics and disclaimer
 cobalt is a tool for easing content downloads from internet and takes ***zero liability***. you are responsible for what you download, how you use and distribute that content. please be mindful when using content of others and always credit original creators. fair use and credits benefit everyone.
@@ -71,11 +72,11 @@ cobalt is my passion project, update schedule depends solely on my free time, mo
 ## cobalt licenses
 cobalt code is licensed under [AGPL-3.0](https://github.com/wukko/cobalt/blob/current/LICENSE).
 
-update banners and various assets of cobalt branding included within the repo are *not* covered by the AGPL-3.0 license and cannot be used using same terms. 
+update banners and various assets of cobalt branding included within the repo are *not* covered by the AGPL-3.0 license and cannot be used using same terms.
 
 ## 3rd party licenses
-[Fluent Emoji by Microsoft](https://github.com/microsoft/fluentui-emoji) (used in cobalt) is under [MIT](https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE) license.  
+[Fluent Emoji by Microsoft](https://github.com/microsoft/fluentui-emoji) (used in cobalt) is under [MIT](https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE) license.
 
 [Noto Sans Mono](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/) fonts (used in cobalt) are licensed under the [OFL](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/about) license.
 
-many update banners were taken from [tenor.com](https://tenor.com/).
+many update banners were taken from [tenor.com](https://tenor.com/).

docs/api.md

@@ -1,18 +1,19 @@
 # cobalt api documentation
-this document provides info about methods and acceptable variables for all cobalt api requests.  
+this document provides info about methods and acceptable variables for all cobalt api requests.
 
-```
+```yml
-👍 you can use co.wuk.sh instance in your projects for free, just don't be an asshole.
+# 👍 you can use co.wuk.sh instance in your projects for free, just don't be an asshole.
 ```
 
 ## POST: `/api/json`
-cobalt's main processing endpoint.  
+cobalt's main processing endpoint.
 
-request body type: `application/json`  
+request body type: `application/json`
-response body type: `application/json`  
 
-```
+response body type: `application/json`
-⚠️ you must include Accept and Content-Type headers with every POST /api/json request.
+
+```yml
+# ⚠️ you must include Accept and Content-Type headers with every POST /api/json request.
 
 Accept: application/json
 Content-Type: application/json
@@ -45,7 +46,7 @@ Content-Type: application/json
 | `audio`      | `string` | direct link to a file or a link to cobalt's live render     |
 
 ### picker item variables
-item type: `object` 
+item type: `object`
 
 | key     | type     | variables                                               | description                            |
 |:--------|:---------|:--------------------------------------------------------|:---------------------------------------|
@@ -54,7 +55,7 @@ item type: `object`
 | `thumb` | `string` | item thumbnail that's displayed in the picker           | used only for `video` type.            |
 
 ## GET: `/api/stream`
-cobalt's live render (or stream) endpoint. used for sending various media content over to the user.  
+cobalt's live render (or stream) endpoint. used for sending various media content over to the user.
 
 ### request query variables
 | key  | variables        | description                                                                                                                    |
@@ -65,7 +66,8 @@ cobalt's live render (or stream) endpoint. used for sending various media conten
 | `e`  | expiry timestamp |                                                                                                                                |
 
 ## GET: `/api/serverInfo`
-returns current basic server info.  
+returns current basic server info.
+
 response body type: `application/json`
 
 ### response body variables

docs/run-an-instance.md

@@ -6,22 +6,27 @@ if you need help with installing docker, follow *only the first step* of these t
 - [how to install docker](https://www.digitalocean.com/community/tutorial-collections/how-to-install-and-use-docker)
 - [how to install docker compose](https://www.digitalocean.com/community/tutorial-collections/how-to-install-docker-compose)
 
-## how to run a cobalt docker package: 
+## how to run a cobalt docker package:
-1. create a folder for cobalt config file, something like this:  
+1. create a folder for cobalt config file, something like this:
+
     ```sh
     mkdir cobalt
-    ```  
+    ```
+
+2. go to cobalt folder, and create a docker compose config file:
 
-2. go to cobalt folder, and create a docker compose config file:  
     ```sh
     cd cobalt && nano docker-compose.yml
-    ```  
+    ```
-    i'm using `nano` in this example, it may not be available in your distro. you can use any other text editor.  
 
-3. copy and paste the [sample config from here](https://github.com/wukko/cobalt/blob/current/docs/examples/docker-compose.example.yml) for either web or api instance (or both, if you wish) and edit it to your needs.  
+    i'm using `nano` in this example, it may not be available in your distro. you can use any other text editor.
-    make sure to replace default URLs with your own or cobalt won't work correctly.  
+
+3. copy and paste the [sample config from here](https://github.com/wukko/cobalt/blob/current/docs/examples/docker-compose.example.yml) for either web or api instance (or both, if you wish) and edit it to your needs.
+
+    **make sure to replace default URLs with your own or cobalt won't work correctly.**
 
 4. finally, start the cobalt container (from cobalt directory):
+
     ```sh
     docker compose up -d
     ```

docs/troubleshooting.md

@@ -1,32 +1,38 @@
 # self-troubleshooting cobalt
-```
+
+```txt
 🚧 this page is work-in-progress. expect more guides to be added in the future!
 ```
-if any issues occur while using cobalt, you can fix many of them yourself. this document aims to provide guides on how to fix most complicated of them.  
+
-use wiki navigation on right to jump between solutions.  
+if any issues occur while using cobalt, you can fix many of them yourself. this document aims to provide guides on how to fix most complicated of them.
+
+use wiki navigation on right to jump between solutions.
 
 ## how to fix clipboard pasting in firefox
 you can fix this issue by changing a single preference in `about:config`.
 
 ### steps to enable clipboard functionality
-1. go to `about:config`:  
+1. go to `about:config`:
 
-   ![screenshot showing about:config entered into address bar](https://github.com/wukko/cobalt/assets/71202418/9ad78612-a372-4949-aeac-99dfc41e273c)  
+   ![screenshot showing about:config entered into address bar](https://github.com/wukko/cobalt/assets/71202418/9ad78612-a372-4949-aeac-99dfc41e273c)
 
-2. if asked, read what firefox has to say and press "accept the risk and continue".  
+2. if asked, read what firefox has to say and press "accept the risk and continue".
- ⚠ tinkering with other preferences may break your browser. **do not** edit them unless you know what you're doing.   
 
-   ![screenshot showing about:config security warning that reads: "proceed with caution. changing advanced configuration preferences can impact firefox performance or security." lower there's a pre-checked checkbox that says: "warn me when i attempt to access these preferences". lowest element is a blue button that says "accept the risk and continue"](https://github.com/wukko/cobalt/assets/71202418/02328729-dbfe-4ea4-b2ca-7bcf1998c2ca)  
+   ```txt
+   ⚠ tinkering with other preferences may break your browser. **do not** edit them unless you know what you're doing.
+   ```
 
-3. search for `dom.events.asyncClipboard.readText`  
+   ![screenshot showing about:config security warning that reads: "proceed with caution. changing advanced configuration preferences can impact firefox performance or security." lower there's a pre-checked checkbox that says: "warn me when i attempt to access these preferences". lowest element is a blue button that says "accept the risk and continue"](https://github.com/wukko/cobalt/assets/71202418/02328729-dbfe-4ea4-b2ca-7bcf1998c2ca)
+
+3. search for `dom.events.asyncClipboard.readText`
 
    ![screenshot showing "dom.events.asyncclipboard.readtext" entered into search on about:config page](https://github.com/wukko/cobalt/assets/71202418/7c7f7e3c-6a6a-40df-8436-277489e72e0b)
 
-4. press the toggle button on very right.  
+4. press the toggle button on very right.
 
    ![screenshot showing "dom.events.asyncclipboard.readtext" preference on about:config page with highlighted toggle button on very right](https://github.com/wukko/cobalt/assets/71202418/b45db18e-f4bf-4f1c-9a8c-f13a63a21335)
 
-5. "false" should change to "true".  
+5. "false" should change to "true".
 
    ![screenshot showing "dom.events.asyncclipboard.readtext" preference on about:config page, this one with "true" text highlighted](https://github.com/wukko/cobalt/assets/71202418/4869b4ff-8385-4cd3-ae59-aa2e03a58b5f)