Reformat Markdown documentation with prettier

theyosh · Jul 18, 2024 · 026de8a · 026de8a
1 parent b99f4ff
commit 026de8a
Show file tree

Hide file tree

Showing 155 changed files with 1,919 additions and 1,582 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -24,7 +24,7 @@ description: >- # used by seo meta and the atom feed
 
 # Fill in the protocol & hostname for your site.
 # e.g. 'https://username.github.io', note that it does not end with a '/'.
-url: "https://theyosh.github.io"
+url: 'https://theyosh.github.io'
 
 feed:
   disable_in_development: true
@@ -154,10 +154,10 @@ pwa:
 paginate: 6
 
 # The base URL of your site
-baseurl: "/TerrariumPI"
+baseurl: '/TerrariumPI'
 
 target-blank:
-    add_css_classes: external
+  add_css_classes: external
 
 plugins:
   - jekyll-feed
@@ -169,7 +169,7 @@ plugins:
 # ------------ The following options are not recommended to be modified ------------------
 
 kramdown:
-  footnote_backlink: "&#8617;&#xfe0e;"
+  footnote_backlink: '&#8617;&#xfe0e;'
   syntax_highlighter: rouge
   syntax_highlighter_opts: # Rouge Options › https://github.com/jneen/rouge#full-options
     css_class: highlight
@@ -194,7 +194,7 @@ collections:
 
 defaults:
   - scope:
-      path: "" # An empty string here means all files in the project
+      path: '' # An empty string here means all files in the project
       type: posts
     values:
       layout: post
@@ -210,7 +210,7 @@ defaults:
     values:
       comments: false
   - scope:
-      path: ""
+      path: ''
       type: tabs # see `site.collections`
     values:
       layout: post
@@ -239,13 +239,13 @@ defaults:
       dynamic_title: true
       permalink: /faq/:title/
   - scope:
-      type: categories  # Used in _plugins/all_tags_and_categories.rb
+      type: categories # Used in _plugins/all_tags_and_categories.rb
     values:
       layout: category
       permalink: /categories/:name/
       dynamic_title: true
   - scope:
-      type: tags  # Used in _plugins/all_tags_and_categories.rb
+      type: tags # Used in _plugins/all_tags_and_categories.rb
     values:
       layout: tag
       permalink: /tags/:name/
@@ -277,13 +277,13 @@ compress_html:
     envs: [development]
 
 exclude:
-  - "*.gem"
-  - "*.gemspec"
+  - '*.gem'
+  - '*.gemspec'
   - docs
   - tools
   - README.md
   - LICENSE
-  - "*.config.js"
+  - '*.config.js'
   - package*.json
 
 jekyll-archives:

diff --git a/docs/_data/authors.yml b/docs/_data/authors.yml
@@ -1,4 +1,4 @@
 theyosh:
   name: TheYOSH
   url: https://github.com/theyosh
-  picture: /assets/img/profile_image.jpg
+  picture: /assets/img/profile_image.jpg
diff --git a/docs/_data/contact.yml b/docs/_data/contact.yml
@@ -1,27 +1,27 @@
 #  The contact options.
 
 - type: github
-  icon: "fab fa-github"
+  icon: 'fab fa-github'
 
 #- type: twitter
 #  icon: "fab fa-twitter"
 
 - type: email
-  icon: "fas fa-envelope"
+  icon: 'fas fa-envelope'
   noblank: true # open link in current tab
 
 - type: rss
-  icon: "fas fa-rss"
+  icon: 'fas fa-rss'
   noblank: true
 # Uncomment and complete the url below to enable more contact options
 #
 - type: mastodon
-  icon: 'fab fa-mastodon'   # icons powered by <https://fontawesome.com/>
-  url:  'https://mastodon.theyosh.nl/@theyosh' # Fill with your Mastodon account page, rel="me" will be applied for verification
+  icon: 'fab fa-mastodon' # icons powered by <https://fontawesome.com/>
+  url: 'https://mastodon.theyosh.nl/@theyosh' # Fill with your Mastodon account page, rel="me" will be applied for verification
 #
 - type: linkedin
-  icon: 'fab fa-linkedin'   # icons powered by <https://fontawesome.com/>
-  url:  'https://www.linkedin.com/in/theyosh' # Fill with your Linkedin homepage
+  icon: 'fab fa-linkedin' # icons powered by <https://fontawesome.com/>
+  url: 'https://www.linkedin.com/in/theyosh' # Fill with your Linkedin homepage
 #
 # - type: stack-overflow
 #   icon: 'fab fa-stack-overflow'

diff --git a/docs/_data/share.yml b/docs/_data/share.yml
@@ -2,39 +2,35 @@
 #  Icons from <https://fontawesome.com/>
 
 platforms:
-  -
-    type: Twitter
-    icon: "fab fa-twitter"
-    link: "https://twitter.com/intent/tweet?text=TITLE&url=URL"
-  -
-    type: Facebook
-    icon: "fab fa-facebook-square"
-    link: "https://www.facebook.com/sharer/sharer.php?title=TITLE&u=URL"
-  -
-    type: Telegram
-    icon: "fab fa-telegram"
-    link: "https://telegram.me/share?text=TITLE&url=URL"
+  - type: Twitter
+    icon: 'fab fa-twitter'
+    link: 'https://twitter.com/intent/tweet?text=TITLE&url=URL'
+  - type: Facebook
+    icon: 'fab fa-facebook-square'
+    link: 'https://www.facebook.com/sharer/sharer.php?title=TITLE&u=URL'
+  - type: Telegram
+    icon: 'fab fa-telegram'
+    link: 'https://telegram.me/share?text=TITLE&url=URL'
 
   # Uncomment below if you need to.
-  -
-    type: Linkedin
-    icon: "fab fa-linkedin"
-    link: "https://www.linkedin.com/sharing/share-offsite/?url=URL"
+  - type: Linkedin
+    icon: 'fab fa-linkedin'
+    link: 'https://www.linkedin.com/sharing/share-offsite/?url=URL'
   #
   # -
   #   type: Weibo
   #   icon: "fab fa-weibo"
   #   link: "http://service.weibo.com/share/share.php?title=TITLE&url=URL"
 
   - type: Mastodon
-    icon: "fa-brands fa-mastodon"
+    icon: 'fa-brands fa-mastodon'
     # See: https://github.com/justinribeiro/share-to-mastodon#properties
     instances:
       - label: mastodon.social
-        link: "https://mastodon.social/"
+        link: 'https://mastodon.social/'
       - label: mastodon.online
-        link: "https://mastodon.online/"
+        link: 'https://mastodon.online/'
       - label: fosstodon.org
-        link: "https://fosstodon.org/"
+        link: 'https://fosstodon.org/'
       - label: photog.social
-        link: "https://photog.social/"
+        link: 'https://photog.social/'
diff --git a/docs/_faq/backup.md b/docs/_faq/backup.md
@@ -3,11 +3,12 @@ title: Which files to backup
 categories: [Website, FAQ]
 tags: [backup]
 ---
+
 If you are running the software for a while, it is handy to backup some files in case of SD card corruption or any other reason that you have to reinstall the software. So here is a list of files that should be saved at a regular basis:
 
-- data/* - Here is the database and calendar data stored
+- data/\* - Here is the database and calendar data stored
 - log/logging.custom.cfg (optional)
-- webcam/archive/* (optional) - Here you can find all the archived images of the used webcams
+- webcam/archive/\* (optional) - Here you can find all the archived images of the used webcams
 
 ### Warning
 

diff --git a/docs/_faq/clean_database.md b/docs/_faq/clean_database.md
@@ -1,8 +1,9 @@
 ---
 title: Cleanup database
 categories: [Website, FAQ]
-tags: [database,cleanup,space]
+tags: [database, cleanup, space]
 ---
+
 If TerrariumPI is running for years it happens that the database get rather big and therefore slowing down the system. Also deleting the data will not give back the disk space. So there is a script which can cleanup the database and reclaim disk space by reducing the database.
 
 In order to cleanup the database, make sure that TerrariumPI is **stopped**! Else there is a possibility on database corruption.

diff --git a/docs/_faq/contact.md b/docs/_faq/contact.md
@@ -1,8 +1,9 @@
 ---
 title: How to contact
 categories: [Website, FAQ]
-tags: [contact,bugs,features,chat]
+tags: [contact, bugs, features, chat]
 ---
+
 There are several ways to contact the developers of TerrariumPI. Here you can see how:
 
 - <a href="https://github.com/theyosh/TerrariumPI" target="_blank" rel="noopener" title="Github for feature requests and bugs">Github for feature requests and bugs</a>

diff --git a/docs/_faq/delete_data.md b/docs/_faq/delete_data.md
@@ -1,7 +1,7 @@
 ---
 title: How to delete a sensor/relay/button TerrariumPI
 categories: [Website, FAQ]
-tags: [delete,manual]
+tags: [delete, manual]
 ---
 
 When you want to delete a sensor/relay/button that has been used for more than 3 months, you should use the manual/debug way to delete the sensor through the GUI. This is due to the time it takes to delete the data from the Sqlite database. If this takes more then 2 minutes, the systemd watchdog will restart TerrariumPI and the delete will not succeed.

diff --git a/docs/_faq/known_errors.md b/docs/_faq/known_errors.md
@@ -7,6 +7,7 @@ tags: [errors]
 The software can produce some warning and deprecation messages. And here is a list of known messages which you can ignore.
 
 ## Bottle
+
 ```
 /home/pi/TerrariumPI/venv/lib/python3.7/site-packages/bottle.py:3383: DeprecationWarning: Absolute template path names are deprecated.
   fname = self.search(name, self.lookup)

diff --git a/docs/_faq/login.md b/docs/_faq/login.md
@@ -3,4 +3,5 @@ title: What is the default login
 categories: [Website, FAQ]
 tags: [login, authentication]
 ---
+
 The default login name is **admin** with password **password**. Make sure you change it after installation at the system setting page.
diff --git a/docs/_faq/malformed_database.md b/docs/_faq/malformed_database.md
@@ -1,8 +1,9 @@
 ---
-title: "sqlite3.DatabaseError: database disk image is malformed"
+title: 'sqlite3.DatabaseError: database disk image is malformed'
 categories: [Website, FAQ]
 tags: [database, malformed]
 ---
+
 It can happen that the database gets corrupted. The error message you will get is something like **sqlite3.DatabaseError: database disk image is malformed**
 
 This can be fixed by replacing it with a backup database. If you do not have backup of that file or the backup is to old, you can try the following steps:

diff --git a/docs/_faq/remote_data.md b/docs/_faq/remote_data.md
@@ -3,6 +3,7 @@ title: How to use remote data
 categories: [Website, FAQ]
 tags: [remote, API]
 ---
+
 It is possible to use remote data with TerrariumPI. At the moment, only JSON and plain text are supported as content types.
 
 ### Rate limits

diff --git a/docs/_faq/reset_authentication.md b/docs/_faq/reset_authentication.md
@@ -3,6 +3,7 @@ title: Reset authentication
 categories: [Website, FAQ]
 tags: [authentication]
 ---
+
 When you loose your password, there is no way to retrieve it. So you need to manually reset it. Use the following steps to clear your existing password, and generate a new one.
 
 1. Stop TerrariumPI ([FAQ]({% link _faq/systemd.md %}#stop))

diff --git a/docs/_faq/reset_webgui.md b/docs/_faq/reset_webgui.md
@@ -1,8 +1,9 @@
 ---
 title: Reset webgui address
 categories: [Website, FAQ]
-tags: [database,gui,address,port,listening]
+tags: [database, gui, address, port, listening]
 ---
+
 If you have configured a fixed IP as address and your PI has changed the IP due to a network change, the TerrariumPI software will not load the web gui. The system is still running, but you are unable to access the webgui.
 
 An error could look like:

diff --git a/docs/_faq/restoring.md b/docs/_faq/restoring.md
@@ -3,6 +3,7 @@ title: Restoring backup files
 categories: [Website, FAQ]
 tags: [backup]
 ---
+
 If you have made regular backups, than you can restore it with the following steps. If the backup has become corrupted, follow [these]({% link _faq/malformed_database.md %}) steps first.
 
 - [Shutdown]({% link _faq/systemd.md %}#stop) TerrariumPI

diff --git a/docs/_faq/systemd.md b/docs/_faq/systemd.md
@@ -3,6 +3,7 @@ title: How to start/stop/restart and disable/enable TerrariumPI
 categories: [Website, FAQ]
 tags: [systemd, service]
 ---
+
 TerrariumPI is using systemd for startup. Here you can find the commands to manually start, stop or restart it. Also there is an option to disable or enable TerrariumPI at boot up.
 
 ### Start

diff --git a/docs/_faq/tune_database.md b/docs/_faq/tune_database.md
@@ -1,8 +1,9 @@
 ---
 title: Tune database settings
 categories: [Website, FAQ]
-tags: [database,stability]
+tags: [database, stability]
 ---
+
 Currently the database SQLITE3 settings are setup for speed. And therefore it cannot handle power outages well. If you need for what ever reason a different SQLITE3 setup, you can create a file called `data/.database-env` with the following contents:
 
 ```
@@ -25,4 +26,4 @@ If you need more [stability](https://www.sqlite.org/howtocorrupt.html) you can u
 
 ```console
 synchronous=FULL
-```
+```
diff --git a/docs/_hardware/1-wire_sensor.md b/docs/_hardware/1-wire_sensor.md
@@ -6,10 +6,10 @@ tags: [sensor, 1-wire, waterproof, temperature, humidity]
 image:
   path: /assets/img/1-Wire.webp
   src: /assets/img/1-Wire.webp
-  alt: "1-Wire header image"
+  alt: '1-Wire header image'
 
-device_types: [temperature,humidity]
-device_address: "Enter the symlink folder name that are available at `/sys/bus/w1/devices/`<br />Ex: `28-0115b231f3ff`"
+device_types: [temperature, humidity]
+device_address: 'Enter the symlink folder name that are available at `/sys/bus/w1/devices/`<br />Ex: `28-0115b231f3ff`'
 device_auto_detect: true
 device_url: https://pinout.xyz/pinout/1_wire
 ---

diff --git a/docs/_hardware/4relay-stack_relay.md b/docs/_hardware/4relay-stack_relay.md
@@ -6,11 +6,11 @@ tags: [relay, i2c, 4relay]
 image:
   path: /assets/img/4relay-stack.webp
   src: /assets/img/4relay-stack.webp
-  alt: "Sequent Microsystems 4 Relay Card header image"
+  alt: 'Sequent Microsystems 4 Relay Card header image'
 
-device_address: "Enter the relay number from 1 - 4. Optional add the stack level number. Default 0.<br />`1,2`"
+device_address: 'Enter the relay number from 1 - 4. Optional add the stack level number. Default 0.<br />`1,2`'
 device_auto_detect: false
-device_url : https://github.com/SequentMicrosystems/4relay-rpi
+device_url: https://github.com/SequentMicrosystems/4relay-rpi
 ---
 
 ## Information
@@ -19,7 +19,7 @@ Drive 8A/240VAC loads and read 3V to 240V, AC or DC, opto-isolated inputs for al
 
 Perfect add-on to your project when you have to control large number of heavy duty AC loads and/or you have to read wide range inputs. Stackable to 8 layers, the card can add up to 32 relays to each Raspberry Pi in a very compact form factor. In addition, you can read up to 32 opto-isolated inputs.
 
-Pluggable connectors make the 4-RELAYS card easy to use when multiple cards are stacked up.  All relays have Normal Open and Normal Close contacts and can switch up to 8A/240VAC.
+Pluggable connectors make the 4-RELAYS card easy to use when multiple cards are stacked up. All relays have Normal Open and Normal Close contacts and can switch up to 8A/240VAC.
 
 The optically isolated universal inputs can read AC or DC signals from 3V to 48V. The input connectors have a low voltage port which can read signals between 3V and 24V, and a high voltage port which can read signals between 24V and 48V.
 

diff --git a/docs/_hardware/4relay-stack_v4.md b/docs/_hardware/4relay-stack_v4.md
@@ -6,11 +6,11 @@ tags: [relay, i2c, 4relay]
 image:
   path: /assets/img/4relay-stack_v4.webp
   src: /assets/img/4relay-stack_v4.webp
-  alt: "Sequent Microsystems 4 Relay Card Ver. 4 header image"
+  alt: 'Sequent Microsystems 4 Relay Card Ver. 4 header image'
 
-device_address: "Enter the relay number from 1 - 4. Optional add the stack level number. Default 0.<br />`1,2`"
+device_address: 'Enter the relay number from 1 - 4. Optional add the stack level number. Default 0.<br />`1,2`'
 device_auto_detect: false
-device_url : https://github.com/SequentMicrosystems/4relind-rpi
+device_url: https://github.com/SequentMicrosystems/4relind-rpi
 ---
 
 ## Information

diff --git a/docs/_hardware/8relay-stack_relay.md b/docs/_hardware/8relay-stack_relay.md
@@ -6,11 +6,11 @@ tags: [relay, i2c, 8relay]
 image:
   path: /assets/img/8relay-stack_v1v2.webp
   src: /assets/img/8relay-stack_v1v2.webp
-  alt: "Sequent Microsystems 8 Relay Card Ver. 1 - 2 header image"
+  alt: 'Sequent Microsystems 8 Relay Card Ver. 1 - 2 header image'
 
-device_address: "Enter the relay number from 1 - 8. Optional add the stack level number. Default 0.<br />`1,2`"
+device_address: 'Enter the relay number from 1 - 8. Optional add the stack level number. Default 0.<br />`1,2`'
 device_auto_detect: false
-device_url : https://github.com/SequentMicrosystems/relay8-rpi
+device_url: https://github.com/SequentMicrosystems/relay8-rpi
 ---
 
 ## Information

diff --git a/docs/_hardware/8relay-stack_v3_relay.md b/docs/_hardware/8relay-stack_v3_relay.md
@@ -6,11 +6,11 @@ tags: [relay, i2c, 8relay]
 image:
   path: /assets/img/8relay-stack_v3.webp
   src: /assets/img/8relay-stack_v3.webp
-  alt: "Sequent Microsystems 8 Relay Card Ver. 3 header image"
+  alt: 'Sequent Microsystems 8 Relay Card Ver. 3 header image'
 
-device_address: "Enter the relay number from 1 - 8. Optional add the stack level number. Default 0.<br />`1,2`"
+device_address: 'Enter the relay number from 1 - 8. Optional add the stack level number. Default 0.<br />`1,2`'
 device_auto_detect: false
-device_url : https://github.com/SequentMicrosystems/8relay-rpi
+device_url: https://github.com/SequentMicrosystems/8relay-rpi
 ---
 
 ## Information