fix: format markdown

Author: josecelano

README.md

@@ -1,8 +1,10 @@
 # Torrust Documentation
-This is the documentation site for all Torrust projects.
+
+This is the documentation site for the Torrust [Tracker](https://github.com/torrust/torrust-tracker) and [Index](https://github.com/torrust/torrust-index).
 
 ## Installation
-### Prerequisites (installed)
+
+__Prerequisites:__
 
 - [Python](https://www.python.org/)
 - [pip](https://pip.pypa.io/en/stable/installing/)
@@ -16,29 +18,25 @@ pip3 install mkdocs
 pip3 install mkdocs-material
 ```
 
-### Project Files
-
-Clone repo:
+__Install:__
 
 ```bash
 git clone https://github.com/torrust/torrust-documentation.git
 ```
 
 ## Usage
 
-### Run Development
+__Run for development:__
 
 Navigate to the project folder (docs) and run the following command:
 
 ```bash
 mkdocs serve
 ```
 
-### Test Development
-
 Visit `http://localhost:8000` to see live changes.
 
-### Run Production
+__Run for production:__
 
 Navigate to the project folder (docs) and build the static site:
 
@@ -49,5 +47,5 @@ mkdocs build
 Publish the newly built docs/site folder using NGINX or Apache.
 
 ## Contributing
-Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well!
-Any pull request targeting existing issues would be very much appreciated.
+
+Please report any bugs you find to our issue tracker. Ideas and feature requests are welcome as well! Any pull request targeting existing issues would be very much appreciated.

cspell.config.yaml

@@ -0,0 +1,11 @@
+---
+$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
+version: '0.2'
+dictionaryDefinitions:
+  - name: project-words
+    path: './project-words.txt'
+    addWords: true
+dictionaries:
+  - project-words
+ignorePaths:
+  - '/project-words.txt'

docs/torrust-index/api.md

@@ -1,41 +1,51 @@
-# REST API
+# Index REST API
+
 > This page is heavy WIP and missing a lot of endpoints from the newest torrust-index.
+
 ## Authorization
+
 Some routes can only be accessed by logged in users.
 For these routes you have to send the token obtained in [/user/login](api.md#login) in the `Authorization` header as a bearer token.
-<br><br>
+
 For example:
+
 ```http
 Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJleGFtcGxlX3VzZXIiLCJleHAiOjE2MzIyNTQxNjZ9.kyugZXiR88q4n6Ze44HonazDp-sJdq886te9-XHthHg
 ```
 
 ## Errors
+
 Every route always returns a non `2xx` status code for an error.
 If the error is caused by user input the status code will be in the `4xx` range.
 Unrecoverable server errors return a `500` status code.
 
 Every error contains a error message that is safe to display to an user.
 The body of an error _should_ always look like this:
+
 ```json
 {
   "error": "<error message>"
 }
 ```
 
 ## Torrent
+
 ### `GET /torrents`
+
 Get all torrent information of the listing with `id`, used for loading the data of the TorrentDetails page.
 
-__Optional query params__
+__Optional query params:__
 
 | Param      | Description                 | Value                                                                                                                                             | Example                        |
 |------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|
 | categories | Included categories.        | Comma seperated list.                                                                                                                             | ?categories=music,other,movies |
 | search     | Search term.                | String.                                                                                                                                           | &search=bunny                  |
 | sort       | Sorting and sort direction. | `uploaded_ASC`, `uploaded_DESC`, `seeders_ASC`, `seeders_DESC`, `leechers_ASC`, `leechers_DESC`, `name_ASC`, `name_DESC`, `size_ASC`, `size_DESC` |&sort=size_DESC|
 
-__Response__:
+__Response:__
+
 - On success: Status `200`.
+
 ```json
 {
   "data": {
@@ -57,44 +67,55 @@ __Response__:
   }
 }
 ```
+
 ---
 
 ### `POST /torrent/upload`
+
 Upload a torrent file and create a torrent listing for it in the index.
 
-Consumes a __mutipart__ form with the fields:
+Consumes a __multipart__ form with the fields:
+
 - `title`: Title of the torrent listing.
 - `description`: A Markdown description.
 - `category`: Category this torrent fits in.
 - `torrent`: The torrent file itself.
 
-__Response__:
+__Response:__
+
 - On success: Status `200`, returns id of the newly created torrent listing.
+
 ```json
 {
-    "data": {
-        "torrent_id": 1
-    }
+  "data": {
+    "torrent_id": 1
+  }
 }
 ```
+
 - On error: Standard error, see [Errors](api.md#errors)
 
 ---
 
 ### `GET /torrent/download/<id>`
-Generate and download torrent file with a personal annouce URL for the authenticated user.
 
-__Response__:
-- On success: Status `200`, Personalised .torrent file stream.
+Generate and download torrent file with a personal announce URL for the authenticated user.
+
+__Response:__
+
+- On success: Status `200`, Personalized .torrent file stream.
 - On error: Standard error, see [Errors](api.md#errors)
 
 ---
 
 ### `GET /torrent/<id>`
+
 Get all torrent information of the listing with `id`, used for loading the data of the TorrentDetails page.
 
 __Response__:
+
 - On success: Status `200`.
+
 ```json
 {
   "data": {
@@ -112,16 +133,21 @@ __Response__:
   }
 }
 ```
+
 - On error: Standard error, see [Errors](api.md#errors)
 
 ---
 
 ## Category
+
 ### `GET /category`
+
 Get a list of existing categories.
 
 __Response__:
+
 - On success: Status `200`.
+
 ```json
 {
   "data": [
@@ -156,49 +182,61 @@ __Response__:
   ]
 }
 ```
+
 - On error: Standard error, see [Errors](api.md#errors)
 
 ---
 
 ## User
+
 ### `POST /user/register`
+
 Register (sign-up) a new user account.
 
 `Example: POST /user/register`
+
 __Body__:
-```json 
+
+```json
 {
-	"email": "[email protected]",
-	"username": "example_user",
-	"password": "password",
-	"confirm_password": "password"
+  "email": "[email protected]",
+  "username": "example_user",
+  "password": "password",
+  "confirm_password": "password"
 }
 ```
 
 __Response__:
+
 - On success: Status `200`, with an empty body.
 - On error: Standard error, see [Errors](api.md#errors)
 
 ---
+
 ### `POST /user/login`
+
 Login into an existing account.
 
 __Fields__:
+
 - `login`: Either the email or username of the account
 - `password`: password of the account
-  <br><br>
 
 `Example: POST /user/login`
+
 __Body__:
-```json 
+
+```json
 {
-	"login": "[email protected]",
-	"password": "password"
+  "login": "[email protected]",
+  "password": "password"
 }
 ```
 
 __Response__:
+
 - On success: Status `200`.
+
 ```json
 {
   "data": {
@@ -207,39 +245,50 @@ __Response__:
   }
 }
 ```
+
 - On error: Standard error, see [Errors](api.md#errors)
 
 ---
 
 ### `GET /user/verify/<token>`
-Email verification handler. <br>
+
+Email verification handler.
+
 On register an email is sent to the email address of the registered account with a link to this route to verify their email address.
 
 `Example: GET /user/verify/<token>`
+
 __Response__:
+
 - On success: Status `200`.
+
 ```html
 Email verified, you can close this page.
 ```
+
 - On error: Error message as a string.
+
 ```html
 Token invalid.
 ```
 
 ---
 
 ### `DELETE /user/ban/<username>`
+
 Ban users.
 
 `Example: DELETE /user/verify/<username>`
 __Response__:
+
 - On success: Status `200`.
 
 ```json
 {
   "message": "User successfully banned!"
 }
 ```
+
 - On error: Error message as a string.
 
 ```json
@@ -249,4 +298,3 @@ __Response__:
 ```
 
 ---
-

docs/torrust-index/config.md

@@ -1,29 +1,35 @@
-# Configuring Torrust
+# Configuring the Index
+
 Torrust's configuration is a simple TOML file. If no TOML file is found, it will fail on startup.
 
 ## Must change
+
 > These are all the configuration options that can affect the security of your instance. Please make sure to change these to your own values.
+
 - `tracker.token`
 - `auth.secret_key`
 
 ## Configuration
 
 ### Tracker
+
 - `REQUIRED` `url`: public UDP url of the torrust-tracker instance.
 - `REQUIRED` `api_url`: URL of the torrust-tracker API, usually `http://localhost:1212`.
 - `REQUIRED` `token`: token configured in the torrust-tracker configuration.
 - `REQUIRED` `token_valid_seconds`: Lifetime of a tracker key.
 
 ### NET
-- `REQUIRED` `port`: The port the API will listen on. It's not advised to use ports under 1024 because root access is required for these ports.
-- `OPTIONAL` `base_url`: The URL this application is accesible from. Used to build the email verification URL. If not set it uses the hostname the endpoint was called from.
 
+- `REQUIRED` `port`: The port the API will listen on. It's not advised to use ports under 1024 because root access is required for these ports.
+- `OPTIONAL` `base_url`: The URL this application is accessible from. Used to build the email verification URL. If not set it uses the hostname the endpoint was called from.
 
 ### Database
-- `REQUIRED` `connect_url`: The connection URL of the database. Should always start with `sqlite:`, no other databases are supported as of now.Including `mode=rwc` allows the database to be `Read / Writed / Created`. Example: `sqlite://data.db?mode=rwc`
+
+- `REQUIRED` `connect_url`: The connection URL of the database. Should always start with `sqlite:`, no other databases are supported as of now.Including `mode=rwc` allows the database to be `Read / Written / Created`. Example: `sqlite://data.db?mode=rwc`
 - `REQUIRED` `torrent_info_update_interval`: Interval in seconds for updating torrent seeder and leecher information. This can be a heavy operation depending on the amount of torrents that are tracked, and thus is not recommended to be lower than `1800` seconds.
 
 ### Mail
+
 - `REQUIRED` `server`: Hostname or IP address of a SMTP server.
 - `REQUIRED` `port`: Port of the SMTP server.
 - `REQUIRED` `username`: Username for authenticating with the specified SMTP server.
@@ -32,14 +38,17 @@ Torrust's configuration is a simple TOML file. If no TOML file is found, it will
 - `REQUIRED` `reply_to`: Email address to which replies on the emails should be sent. Can also be a non reply address, or the same as the from address.
 
 ### Auth
+
 - `REQUIRED` `min_password_length`: Minimum length of a password when registering a new user.
 - `REQUIRED` `max_password_length`: Maximum length of a password when registering a new user.
-- `REQUIRED` `secret_key`: Signing key of the JWT authentication tokens. Keeping these default will severly impact the security of your instance, and allows attackers to login as any user.
+- `REQUIRED` `secret_key`: Signing key of the JWT authentication tokens. Keeping these default will severely impact the security of your instance, and allows attackers to login as any user.
 
 ### Storage
+
 - `REQUIRED` `upload_path`: Path where uploads should be stored. Directories will be automatically created on startup if they don't exist.
 
 ## Default
+
 ```toml
 [website]
 name = "Torrust"