.forgejo/workflows/lint.yml

@@ -12,6 +12,12 @@ jobs:
       - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
       - name: Check out repository code
         uses: actions/checkout@v4
+      - name: Lint Markdown files
+        uses: actions/markdownlint-cli2-action@v17
+        with:
+          globs: |
+            **/*.md
+            !vendor/*.md
       - name: Install linters using Composer
         run: |
           export COMPOSER_HOME=/tmp

README.md

@@ -1,17 +1,23 @@
 # ClickAt
 
-[Shaarli](https://github.com/shaarli/Shaarli/) plugin to make microblogging 
-social networks (Twitter/𝕏, Threads, Bluesky and Fediverse) addresses clickable. 
+[Shaarli](https://github.com/shaarli/Shaarli) plugin to make microblogging
+social networks (Twitter/𝕏, Threads, Bluesky and Fediverse) addresses
+clickable.
 
 ## Manual
 
 1. Clone repository in `plugins` directory (plugin directory name must be `clickat`)
+
+    ```shell
+    git clone https://forge.tourmentine.com/n/shaarli-plugin-clickat.git path/to/shaarli/plugins/clickat
     ```
-$ git clone https://forge.tourmentine.com/n/shaarli-plugin-clickat.git path/to/shaarli/plugins/clickat
-```
+
 2. Activate plugin.
 3. Quote users from:
-    - Twitter/𝕏 with their `@nic`, 
-    - Threads with `@nic@threads.net`,
-    - Bluesky with `@nic.bsky.social`,
-    - Fediverse with `@nic@instance`.
+
+    - Twitter/𝕏 with their `@nic`, it will display [@nic](https://x.com/nic),
+    - Threads with `@nic@threads.net`, it will display
+    [@nic@threads.net](https://threads.net/@nic ),
+    - Bluesky with `@nic.bsky.social`, it will
+    display [@nic@bsky.social](https://bsky.app/profile/nic.bsky.social),
+    - Fediverse with `@nic@instance`, it will display [@nic@instance](https://instance/@nic).