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

@@ -56,6 +56,7 @@ you can use the main api instance ([co.wuk.sh](https://co.wuk.sh/)) in your proj
 
 ## 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).
+
 it's *highly* recommended to use a docker compose method unless you run for developing/debugging purposes.
 
 ## sponsors

docs/api.md

@@ -1,18 +1,19 @@
 # cobalt api documentation
 this document provides info about methods and acceptable variables for all cobalt api requests.
 
-```
-👍 you can use co.wuk.sh instance in your projects for free, just don't be an asshole.
+```yml
+# 👍 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.
 
 request 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
@@ -66,6 +67,7 @@ cobalt's live render (or stream) endpoint. used for sending various media conten
 
 ## GET: `/api/serverInfo`
 returns current basic server info.
+
 response body type: `application/json`
 
 ### response body variables

docs/run-an-instance.md

@@ -8,20 +8,25 @@ if you need help with installing docker, follow *only the first step* of these t
 
 ## how to run a cobalt docker package:
 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:
+
     ```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.
-    make sure to replace default URLs with your own or cobalt won't work correctly.  
+
+    **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,8 +1,11 @@
 # 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.
 
 ## how to fix clipboard pasting in firefox
@@ -14,7 +17,10 @@ you can fix this issue by changing a single preference in `about:config`.
    ![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".
+
+   ```txt
    ⚠ 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)