ci: add markdownlint

.github/workflows/Markdownlint.yml

@@ -0,0 +1,21 @@
+---
+name: Markdownlint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Markdownlint
+        uses: reviewdog/action-markdownlint@3667398db9118d7e78f7a63d10e26ce454ba5f58 # v0.26.2
+        with:
+          fail_level: any
+          markdownlint_flags: '-s .mdl_style.rb'
+          reporter: github-pr-review

.mdl_style.rb

@@ -0,0 +1,10 @@
+all
+rule 'MD029', style: :ordered
+
+exclude_rule 'MD002' # This conflicts with the way we generate HTML from markdown.
+exclude_rule 'MD013' # Line length limits hold you back.
+exclude_rule 'MD026' # Trailing punctuation in headers can be grammatically useful.
+exclude_rule 'MD032' # This conflicts with the way we generate HTML from markdown if we have multiple authors.
+exclude_rule 'MD034' # Sometimes a bare URL is exactly what you want.
+exclude_rule 'MD036' # We purposefully use emphases instead of headers sometimes.
+exclude_rule 'MD041' # This conflicts with the way we generate HTML from markdown.

README.md

@@ -1,15 +1,17 @@
 # wiki
 
-welcome to the linux society wiki repo! 
+welcome to the linux society wiki repo!
 
 ## contributing
 
 if you would like to contribute to the wiki, make a pull request with the edits you would like to make.
 
 ### new articles
+
 please place any new articles inside of the `content/` directory.
 
 ### attributions
+
 to be attributed for your work, add your github username into the `authors` section of the markdown file's frontmatter.
 an example:
 
@@ -20,4 +22,4 @@ authors:
 - username3 # <- editor
 ```
 
-these authors should be ordered by the amount they have contributed to the article.
+these authors should be ordered by the amount they have contributed to the article.

content/eduroam.md

@@ -1,6 +1,6 @@
 ---
 id: eduroam
-title: "how do i connect to eduroam on <distro>?"
+title: "how do i connect to eduroam on $distro?"
 aliases: []
 tags: []
 authors:
@@ -14,7 +14,7 @@ layout: base.njk
 
 **tldr: try [arubaquickconnect4all](https://github.com/alzer89/ArubaQuickConnect4All)**
 
-eduroam at unsw is an aruba-managed wireless network, meaning that it only officially supports ubuntu. if you are looking to connect on a distro other than ubuntu, an option is [arubaquickconnect4all](https://github.com/alzer89/ArubaQuickConnect4All). 
+eduroam at unsw is an aruba-managed wireless network, meaning that it only officially supports ubuntu. if you are looking to connect on a distro other than ubuntu, an option is [arubaquickconnect4all](https://github.com/alzer89/ArubaQuickConnect4All).
 by doing so, you will get higher speeds compared to using unsw-iot :)
 
 all the following steps assume you have cloned the repo already (see steps on github).
@@ -61,9 +61,9 @@ please note that the below is a temporary solution which may stop working at any
 ```sh
  nmcli connection edit
  # type wifi in to make a new wifi connection
-    
+
     set connection.id yourConnectionName
-    
+
     set wifi.ssid eduroam
 
     set 802-1x.eap peap

content/iot.md

@@ -13,20 +13,12 @@ layout: base.njk
 
 If you don't want to use eduroam, UNSW-IoT is another option. You may want to do this if you are not interested in `aqc4all`, or don't want to use the deprecated method of connecting to eduroam.
 
-The issues with iot that you may have patchy reception in some buildings (e.g. Keith Burrows), and that iot isn't officially supported for personal devices. 
+The issues with iot that you may have patchy reception in some buildings (e.g. Keith Burrows), and that iot isn't officially supported for personal devices.
 
 ![Connction to UNSW-IoT on i3status bar](/assets/UNSW-IoT-connection.png)
 
 The way UNSW-IoT works is that you put down your MAC address in an online portal and they provide you a password to connect with. **This will not work with setups and operating systems that randomise your MAC address, so ensure you disable these settings :)**
 
-<div>
-
----
-
----
-
-</div>
-
 See the bottom of the document at [#acquire-your-macv4-address](#acquire-your-macv4-address) to get your MACv4 address, it should look like the string `XX:XX:XX:XX:XX:XX` where each `XX` are hex bytes.
 
 1. **Go here** [https://www.unsw.edu.au/myit/services/wifi-network/connecting-to-the-unsw-network/get-online/internet-of-things-device](https://www.unsw.edu.au/myit/services/wifi-network/connecting-to-the-unsw-network/get-online/internet-of-things-device) - Click **Get online →**
@@ -39,19 +31,6 @@ See the bottom of the document at [#acquire-your-macv4-address](#acquire-your-ma
 
 ![Create new UNSW-IoT device portal](/assets/UNSW-IoT-create-new-device.png)
 
-
-
-
-<div>
-
----
-
----
-
-
-</div>
-
-
 ## Acquire your MACv4 address
 
 ### Use ip addr or /proc
@@ -69,7 +48,7 @@ and extract out the `XX:XX:XX:XX:XX:XX` for the thing that isn't the loopback, s
 Otherwise, you can use proc filesystem
 
 ```sh
-cat /sys/class/net/wlan0/address 
+cat /sys/class/net/wlan0/address
 # XX:XX:XX:XX:XX:XX
 ```
 
@@ -81,9 +60,10 @@ cat /sys/class/net/wlan0/address
 iwctl station wlan0 show
 #
 #            ....
-#            Connected network     ???                                         
-#            IPv4 address          ??.??.??.??                                     
+#            Connected network     ???
+#            IPv4 address          ??.??.??.??
 #            ConnectedBss          XX:XX:XX:XX:XX:XX
-#            .... 
-#            .... 
-#            .... 
+#            ....
+#            ....
+#            ....
+```