Make linters happy (#723)

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/723
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>

.cspell.json

@@ -118,7 +118,8 @@
     "Ente",
     "getent",
     "sealioning",
-    "DNSSEC"
+    "DNSSEC",
+    "Arminiusstraße"
   ],
   "ignorePaths": [
     "**/node_modules/**/*",

.lycheeignore

@@ -9,3 +9,4 @@ https://openclipart.org/**
 https://www.gnu.org/**
 https://translate.codeberg.org
 https://stackoverflow.com/**
+https://medium.com/technical-writing-is-easy/screenshots-in-documentation-27b45342aad8

.woodpecker/lint.yaml

@@ -8,7 +8,7 @@ steps:
   lint-markdown:
     image: davidanson/markdownlint-cli2:v0.19.1
     commands:
-      - 'markdownlint-cli2 **/*.{md,markdown}'
+      - 'markdownlint-cli2 **/*.md'
     when:
       path:
         include: ['.woodpecker/*.yaml', '*.{md,markdown}']

content/codeberg-pages/index.md

@@ -72,7 +72,8 @@ can be accessed via `https://username.codeberg.page/@docs~develop/README.md`).
 
 ## Advanced Usage: Custom error page for 404s
 
-You can replace the default 404 error page that Codeberg Pages will show for missing pages with your own version if you prefer.
+You can replace the default 404 error page that Codeberg Pages will show for missing pages with your own version if you
+prefer.
 To do so start by writing your own HTML file that you want to serve instead.
 
 After creating the HTML with your custom error message, save it as `404.html` in the root of your

content/codeberg-pages/pushing-output.md

@@ -85,7 +85,8 @@ git push origin HEAD:your-remote-branch-name
 
 Replace `your-remote-branch-name` with the name of your remote branch. It is recommended to initially push your commits
 to a branch other than the default branch. Once you have made sure everything went smoothly, you can then make a pull
-request to merge it into the default branch. To learn more about pull requests, read the article [Pull requests and Git flow](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/).
+request to merge it into the default branch. To learn more about pull requests, read the article
+[Pull requests and Git flow](https://docs.codeberg.org/collaborating/pull-requests-and-git-flow/).
 
 {% endadmonition %}
 

content/collaborating/citable-code.md

@@ -8,8 +8,8 @@ eleventyNavigation:
 The easiest way to refer to your code is to send/post the URL of your repository.
 However, if you need to reliably refer to a specific version of your code in the long run, for example for scientific
 writing, this is not really viable, because URLs can change.
-Another possibility is to download your repository as a ZIP or TAR.GZ archive (see section Clone in [Clone & Commit via Web](/git/clone-commit-via-web))
-and share this file.  
+Another possibility is to download your repository as a ZIP or TAR.GZ archive (see section Clone in
+[Clone & Commit via Web](/git/clone-commit-via-web)) and share this file.  
 The third option, which actually complements the second, is to assign a [Digital Object Identifier](https://www.doi.org/)
 (DOI) to your code. Having a DOI for your code means that everybody can cite your code using this _standard_
 and _permanent identifier_.
@@ -21,7 +21,8 @@ This page will show you how to do just that. The process can be decomposed in fo
 
 Creating a release is optional, but recommended. A release will make it clear what version of your code you want to share/cite.
 Any further edits to your code will not be included in the release.
-In other words, it's good practice to share/cite a release with fixed code rather than the always changing code of your repository.
+In other words, it's good practice to share/cite a release with fixed code rather than the always changing code of your
+repository.
 
 You can find instructions on the [Tags and Releases article](/git/using-tags/#creating-tags-and-releases).
 

content/collaborating/create-organization.md

@@ -9,8 +9,8 @@ eleventyNavigation:
 ## What is an organization?
 
 An organization is a group of users that have access to a shared account.
-As such, they can all access the different repositories of the organization. An organization can be composed of several teams,
-each having a defined role in the project's development and also different access rights.
+As such, they can all access the different repositories of the organization. An organization can be composed of several
+teams, each having a defined role in the project's development and also different access rights.
 This makes organizations an easy and powerful tool to collaborate on a project.
 
 Everyone can create organizations on Codeberg for free. The following sections will show you how to create and manage an

content/collaborating/pull-requests-and-git-flow.md

@@ -23,7 +23,8 @@ individuals and teams, a collaborative workflow based on pull requests provides
 
 Let's say, you would like to contribute to our "examples" project [knut/examples](https://codeberg.org/knut/examples).
 
-First, fork the project you would like to work on, by clicking the `Fork` button in the top-right corner of the project page:
+First, fork the project you would like to work on, by clicking the `Fork` button in the top-right corner of the project
+page:
 
 ![Fork a project](/images/collaborating/pull-requests-and-git-flow/fork-button.png)
 

content/collaborating/resolve-conflicts.md

@@ -236,7 +236,8 @@ If you have more than one conflict in one or more files, repeat the resolution p
 Make sure not to leave any lines starting with `<<<<<<<`, `=======`, and `>>>>>>>`, as Git no longer knows that these
 are special and will treat them as normal text.
 
-Issuing `git commit` without any comment will open the default editor, and lets you edit a commit message for the merge commit.
+Issuing `git commit` without any comment will open the default editor, and lets you edit a commit message for the merge
+commit.
 Closing the editor will complete the resolution of the merge conflict.
 
 > `git log` shows you both the original commit that lead to the conflict and the merge commit.

content/contact.md

@@ -60,7 +60,8 @@ or asked via the public channels above.
 
 Please direct **media and press inquiries** to [press@codeberg.org](mailto:press-PLEASE-REMOVE-THIS-FOR-SPAM-PROTECTION@codeberg.org).
 
-This mailbox is operated by volunteers on a best effort basis and not by a traditional public communications department. If you are seeking comment within a given timeframe, feel free to disclose this in your inquiry.
+This mailbox is operated by volunteers on a best effort basis and not by a traditional public communications department.
+If you are seeking comment within a given timeframe, feel free to disclose this in your inquiry.
 
 ### Abuse
 

content/getting-started/first-repository.md

@@ -243,7 +243,8 @@ so you should add at least the licence and `README.md` yourself.
 
 Now that you've connected your repository to your local development copy, it's time to make your first commit.
 
-> If you didn't generate the `LICENSE` and `README.md` files when creating the repository, it's a good idea to add them now.
+> If you didn't generate the `LICENSE` and `README.md` files when creating the repository, it's a good idea to add them
+> now.
 > Just put them in your local development copy's directory and add them to your commit, as shown below.
 
 ### 1. Create or edit a file

content/git/clone-commit-via-web.md

@@ -6,7 +6,8 @@ eleventyNavigation:
   order: 30
 ---
 
-As shown before, cloning, editing, committing, pushing and pulling can be performed using Git directly from the command line.
+As shown before, cloning, editing, committing, pushing and pulling can be performed using Git directly from the command
+line.
 This time, we're going to do this all through the web interface.
 
 The user in these examples is `knut` the polar bear and its repository is `foobar`.

content/git/git-ignore.md

@@ -11,7 +11,8 @@ This helps you and it also helps Codeberg, as we don't have to hold large, unnec
 
 Sometimes additional files are created within the same directory as your source files. These might be, for example binaries.
 
-To prevent accidentally committing those files to your repository, you can add file and directory names to a file named `.gitignore`.
+To prevent accidentally committing those files to your repository, you can add file and directory names to a file named
+`.gitignore`.
 
 Files and directories that match the names in the `.gitignore` file are ignored by Git. They don't show up in `git status`
 and they can't be staged for a commit using `git add` (except when using `--force`).

content/git/reduce-size.md

@@ -138,7 +138,8 @@ to undo in case anything goes wrong.
 
 Remember: Everyone who has a working copy of your repository will now need to move to that new history as well.
 
-For people who don't have any ongoing local work, the easiest way to ensure the correct history is to check out a fresh clone.
+For people who don't have any ongoing local work, the easiest way to ensure the correct history is to check out a fresh
+clone.
 
 For users who have on-going local work, the following steps should work, unless it includes now-deleted files:
 

content/improving-codeberg/contributing-code.md

@@ -25,7 +25,8 @@ organizations, they contain numerous other software and setup projects that will
 ## Getting Started
 
 Having a lot of options to choose from is hard.
-We maintain a place for [all contributions to Codeberg](https://codeberg.org/Codeberg/Contributing) and you should read there.
+We maintain a place for [all contributions to Codeberg](https://codeberg.org/Codeberg/Contributing) and you should read
+there.
 If you don't know where to start, go ahead and introduce yourself there.
 We'll try to match you with relevant and interesting tasks.
 

content/improving-codeberg/donate.md

@@ -31,7 +31,7 @@ develop new features and sustain the Free Software ecosystem around.
     An easy option for people with compatible bank accounts,
     and we have heard of others successfully using providers like Wise to transfer the money.
 
-```
+```text
 Codeberg e.V.
 Arminiusstraße 2 - 4
 10551 Berlin
@@ -39,6 +39,7 @@ Arminiusstraße 2 - 4
 IBAN: DE90 8306 5408 0004 1042 42
 BIC: GENODEF1SLR
 ```
+
    </p>
    The following EPC QR code can be used to initiate a SEPA credit transfer.
    Notice it contains a default amount of 10 Euros, but you can change it to whatever amount you want to donate.

content/markdown/introduction-to-markdown.md

@@ -45,12 +45,12 @@ This gets rendered as
 This is **bold text**.
 
 ```markdown
-This is also __bold text__.
+This is also **bold text**.
 ```
 
 This gets rendered as
 
-This is also __bold text__.
+This is also **bold text**.
 
 ### Italics
 
@@ -62,12 +62,12 @@ to get the same effect.
 Here are a few examples.
 
 ```markdown
-This is *italic text*.
+This is _italic text_.
 ```
 
 This gets rendered as
 
-This is *italic text*.
+This is _italic text_.
 
 ```markdown
 This is also _italic text_.
@@ -92,17 +92,17 @@ This is ~~strikethrough text~~.
 ### Footnotes
 
 To add footnotes use the syntax `[^name]` inline, and define them with:<br>
-`[^name]:text.` 
+`[^name]:text.`
 
 ```markdown
 Text with a footnote.[^1]
 [^1]: A footnote.
 ```
-is rendered as 
+
+is rendered as
 
 ![Footnote Example rendering](/images/markdown/Footnote-example.png)
 
-
 ## Forgejo-specific formatting
 
 ### Emoticons
@@ -154,4 +154,3 @@ E.g.
 is rendered to:
 
 ![Mermaid Example rendering](/images/markdown/mermaid-example.png)
-

package.json

@@ -4,7 +4,12 @@
   "private": true,
   "scripts": {
     "build": "eleventy",
-    "dev": "eleventy --serve --incremental"
+    "dev": "eleventy --serve --incremental",
+    "lint-markdown": "markdownlint-cli2 '**/*.md' '#node_modules'",
+    "lint-markdown-fix": "markdownlint-cli2 --fix '**/*.md' '#node_modules'",
+    "lint-prettier": "prettier --check .",
+    "lint-prettier-fix": "prettier -w --check .",
+    "lint-spellcheck": "cspell lint --no-progress --gitignore '{**,.*}/{*,.*}'"
   },
   "devDependencies": {
     "@11ty/eleventy": "3.1.2",
@@ -15,9 +20,12 @@
     "@fortawesome/free-solid-svg-icons": "7.1.0",
     "@toycode/markdown-it-class": "1.2.4",
     "@uncenter/eleventy-plugin-toc": "1.0.3",
+    "cspell": "^9.4.0",
     "halfmoon": "2.0.2",
     "markdown-it": "14.1.0",
     "markdown-it-anchor": "9.2.0",
-    "pagefind": "1.4.0"
+    "markdownlint-cli2": "^0.20.0",
+    "pagefind": "1.4.0",
+    "prettier": "^3.7.4"
   }
 }