.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
@@ -20,7 +26,7 @@ jobs:
           composer require --dev bamarni/composer-bin-plugin
           composer bin phplint require --dev overtrue/phplint
           composer require --dev friendsofphp/php-cs-fixer
-      - name: Lint
+      - name: Lint PHP files
         run: vendor/bin/phplint --no-cache --no-progress --exclude=vendor --verbose
       - name: PHP CS Fixer
         run: vendor/bin/php-cs-fixer fix --dry-run --verbose --diff .

README.md

@@ -1,12 +1,15 @@
 # ShaarGem
 
-[Shaarli](https://github.com/shaarli/Shaarli/) plugin for [Gemini](https://geminiprotocol.net/) capsules shaaring.
+[Shaarli](https://github.com/shaarli/Shaarli)
+plugin for [Gemini](https://geminiprotocol.net/) capsules shaaring.
 
 ## Manual
 
 1. Clone repository in `plugins` directory (plugin directory name must be `shaargem`)
+
+    ```shell
+    git clone https://forge.tourmentine.com/n/shaarli-plugin-shaargem.git path/to/shaarli/plugins/shaargem
     ```
-$ git clone https://forge.tourmentine.com/n/shaarli-plugin-shaargem.git path/to/shaarli/plugins/shaargem
-```
+
 2. Activate plugin.
 3. Share a `gemini://` IRI.