chore: added Markdownlint configuration (podman-desktop#2299)

Author: themr0c

.markdownlint.yaml

@@ -0,0 +1,12 @@
+# We increment heading levels my more by one level at a time for the Procedure, Verification headings:
+MD001: false
+# We do not limit line length:
+MD013: false
+# We always use Dollar signs before commands:
+MD014: false
+# We have multiple headings with the same content (Prerequisites, Procedure, Verification)
+MD024: false
+# We have multiple top-level headings in the same document to set different page title and navigation title:
+MD025: false
+# We allow inline HTML (icon):
+MD033: false

package.json

@@ -56,6 +56,8 @@
     "watch": "node scripts/watch.cjs",
     "format:check": "prettier --check \"{extensions,packages,tests,types}/**/*.{ts,svelte}\" \"extensions/*/scripts/build.js\" \"website/**/*.{md,js}\" \"website/src/**/*.{css,tsx}\"",
     "format:fix": "prettier --write \"{extensions,packages,tests,types}/**/*.{ts,svelte}\" \"extensions/*/scripts/build.js\" \"website/**/*.{md,js}\" \"website/src/**/*.{css,tsx}\"",
+    "markdownlint:check": "markdownlint-cli2 \"website/**/*.md\" \"#website/node_modules\"",
+    "markdownlint:fix": "markdownlint-cli2-fix \"website/**/*.md\" \"#website/node_modules\"",
     "lint:check": "eslint . --ext js,ts,tsx",
     "lint:fix": "eslint . --fix --ext js,ts,tsx",
     "svelte:check": "svelte-check",

website/README.md

@@ -2,21 +2,21 @@
 
 ### Install the project dependencies
 
-```
+```shell-session
 $ yarn install
 ```
 
 ### Local Development of the website / documentation
 
-```
+```shell-session
 $ yarn start
 ```
 
 This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
 ### Build
 
-```
+```shell-session
 $ yarn build
 ```
 
@@ -26,13 +26,13 @@ This command generates static content into the `build` directory and can be serv
 
 Using SSH:
 
-```
+```shell-session
 $ USE_SSH=true yarn deploy
 ```
 
 Not using SSH:
 
-```
+```shell-session
 $ GIT_USER=<Your GitHub username> yarn deploy
 ```
 

website/blog/2022-11-17-develop-podman-using-codespaces.md

@@ -17,7 +17,7 @@ The challenges are to run a desktop tool (Podman Desktop) and running a containe
 
 ## Defining image of the container
 
-The first thing is in the choice of the image for the container. It is possible to pick-up a default image and add some features but there is no existing feature for Podman at https://github.com/devcontainers/features/tree/main/src and most of the features are expecting to run on top of Debian/Ubuntu
+The first thing is in the choice of the image for the container. It is possible to pick-up a default image and add some features but there is no existing feature for Podman at <https://github.com/devcontainers/features/tree/main/src> and most of the features are expecting to run on top of Debian/Ubuntu
 
 If you are not interested in how to setup the image, jump to the [next section](#configure-the-devcontainer-using-devcontainerjson).
 
@@ -119,14 +119,14 @@ ENV _CONTAINERS_USERNS_CONFIGURED=""
 
 Make sure Podman will create the socket in an expected directory:
 
-```
+```docker
 # socket path for podman
 ENV XDG_RUNTIME_DIR=/run/user/1000
 ```
 
 OK ! we have a custom Containerfile providing all the tools to build and run Podman Desktop (using VNC for the display), run Podman and run Electron.
 
-The current file is available at https://github.com/containers/podman-desktop/blob/main/.devcontainer/.parent/Containerfile
+The current file is available at <https://github.com/containers/podman-desktop/blob/main/.devcontainer/.parent/Containerfile>
 
 Let's configure the DevContainer.
 
@@ -282,7 +282,7 @@ After all post-creation steps, the `Preview` browser inside the VS Code editor w
 
 As a user, opening a workspace with all what we configured is done using a single click.
 
-Go to https://github.com/containers/podman-desktop then click on the `< > Code` dropdown and click on `Create codespace on main` button.
+Go to <https://github.com/containers/podman-desktop> then click on the `< > Code` dropdown and click on `Create codespace on main` button.
 
 ![Open Codespace](img/develop-podman-using-codespaces/codespaces-click-repository.png)
 

website/blog/2022-12-01-release-0.10-blog.md

@@ -99,7 +99,7 @@ For most users on Linux, there is no tray icon support. In this situation, when
 - Fixed use of the full height of the screen when displaying log in the details of a container. ([#946](https://github.com/containers/podman-desktop/discussions/946))
 - Fixed First start of Podman Desktop on flatpak was not seeing the podman engine ([#860](https://github.com/containers/podman-desktop/pull/860))
 
-## Community Thank You!
+## Community Thank You
 
 🎉 We’d like to say a big thank you to everyone who helped to make Podman Desktop 0.10 even better:
 

website/blog/2023-01-18-release-0.11.md

@@ -209,7 +209,7 @@ Several of other improvements have been made to the documentation and the websit
 - Fixed registry URL not aligned with header - [#1205](https://github.com/containers/podman-desktop/pull/1205)
 - Moved SVGs to reusable components - [#1211](https://github.com/containers/podman-desktop/pull/1211)
 
-** Extensions API has also been improved in this new release: **
+**Extensions API has also been improved in this new release:**
 
 - (extension-api): Allows to register a factory for kubernetes connection objects (like for container connections) - [#1040](https://github.com/containers/podman-desktop/pull/1040)
 - (extension-api): List or inspect containers, be notified on events - [#1041](https://github.com/containers/podman-desktop/pull/1041)
@@ -223,7 +223,7 @@ Several of other improvements have been made to the documentation and the websit
 
 ---
 
-## Community Thank You!
+## Community Thank You
 
 🎉 We’d like to say a big thank you to everyone who helped to make Podman Desktop 0.11 even better:
 

website/blog/2023-02-15-release-0.12.md

@@ -137,7 +137,7 @@ The documentation had many editorial reviews, and new content.
 
 ---
 
-## Community Thank You!
+## Community Thank You
 
 🎉 We’d like to say a big thank you to everyone who helped to make Podman Desktop 0.12 even better:
 

website/docs/Installation/macos-install.md

@@ -46,7 +46,7 @@ Podman Desktop requires [Podman Engine](https://docs.podman.io/en/latest/index.h
 
 1. After the installation is complete, close the installation program. Podman Engine has been installed and you are now ready to use Podman Desktop.
 
-## Installing Podman Desktop on MacOS using [brew](https://brew.sh/).
+## Installing Podman Desktop on MacOS using [brew](https://brew.sh/)
 
 :::infoPrerequisite
 

website/docs/Installation/windows-install/installing-podman-with-openshift-local.md

@@ -29,18 +29,19 @@ Consider installing the Podman Preset in OpenShift Local rather than [installing
 
 2. Select the Podman container runtime preset:
 
-   ```
+   ```shell-session
    $ crc config set preset podman
    ```
 
 3. Set up your host machine for Red Hat OpenShift Local:
 
-   ```
+   ```shell-session
    $ crc setup
    ```
 
 4. Start the Red Hat OpenShift instance:
-   ```
+
+   ```shell-session
    $ crc start
    ```
 

website/docs/kubernetes/deploying-a-container-to-kubernetes.md

@@ -32,6 +32,6 @@ With Podman Desktop, you can deploy a container to your Kubernetes cluster.
 
 - On the **Deploy generated pod to Kubernetes** screen, the created pod status is _Phase: Running_
 
-  ![](img/deploying-a-container.png)
+  ![Deploying a container](img/deploying-a-container.png)
 
 - Go to **Containers**: your pod is in the list.

website/docs/kubernetes/deploying-a-pod-to-kubernetes.md

@@ -32,6 +32,6 @@ With Podman Desktop, you can deploy a pod to your Kubernetes cluster.
 
 - On the **Deploy generated pod to Kubernetes** screen, the created pod status is _Phase: Running_
 
-  ![](img/deploying-a-pod.png)
+  ![Deplying a pod](img/deploying-a-pod.png)
 
 - Go to **Pods**: your pod is in the list.

website/docs/kubernetes/kind/installing-kind.md

@@ -19,6 +19,7 @@ tags: [migrating-to-kubernetes, kind]
 1. **<icon icon="fa-solid fa-cog" size="lg" /> Settings > Resources** contain a **Kind** tile.
    ![Kind resource tile](img/kind-resource.png)
 1. You can run the `kind` CLI:
+
    ```shell-session
    $ kind get clusters
    ```

website/docs/migrating-from-docker/emulating-docker-cli-with-podman.md

@@ -31,7 +31,7 @@ Consider emulating Docker CLI with Podman to migrate transparently to Podman.
 
 2. (Optional) Create an empty `/etc/containers/nodocker` file to avoid the `Emulate Docker CLI using podman.` message when running the script.
 
-   ```
+   ```shell-session
    # touch /etc/containers/nodocker
    ```
 

website/docs/migrating-from-docker/using-podman-mac-helper.md

@@ -47,7 +47,7 @@ The service redirects `/var/run/docker` to the fixed user-assigned UNIX socket l
 
    Example:
 
-   ```
+   ```shell-session
    $ podman-mac-helper run -it <your_container> bash
    ```
 

website/docs/troubleshooting.md

@@ -16,7 +16,7 @@ The tool connects to Podman using the socket on the host on macOS and on a named
 This is available only on Podman 4.0.2+
 So, please check your version and update.
 
-On Windows, the named pipe is `//./pipe/docker_engine` when Docker Desktop is not installed. It will be solved by https://github.com/containers/podman/issues/13502 / https://github.com/containers/podman/pull/13655. During that time, you may start Docker Desktop so the named pipe is the one expected.
+On Windows, the named pipe is `//./pipe/docker_engine` when Docker Desktop is not installed. It will be solved by <https://github.com/containers/podman/issues/13502> / <https://github.com/containers/podman/pull/13655>. During that time, you might start Docker Desktop so the named pipe is the one expected.
 
 #### Check connection
 
@@ -50,17 +50,17 @@ Twitter:   @Podman_io
 
 ### Unable to locate Podman Engine
 
-#### Issue:
+#### Issue
 
 Despite having Podman Engine installed, you may receive an error as follows -
 `Error: No such keg: /usr/local/Cellar/podman`
 or any similar error denoting that Podman Engine does not exist.
 
-#### Explanation:
+#### Explanation
 
 The Podman Installer and Homebrew use different locations to store the Podman Engine files in the file system. For example, Podman Installer installs Podman Engine in the path `/opt/podman` whereas Homebrew uses the path `/usr/local` for macOS Intel, `/opt/homebrew` for Apple Silicon and `/home/linuxbrew/.linuxbrew` for Linux.
 
-#### Solution:
+#### Solution
 
 To check where exactly is your Podman Engine installed, run the command-
 
@@ -88,64 +88,49 @@ You can now proceed for a fresh installation of Podman Desktop
 
 ### Unable to see information about active containers
 
-#### Issue:
+#### Issue
 
 In this scenario, the screen may be displaying "No Containers" as shown below despite active containers runnning in the background.
 ![img](img/containers_error.png)
 
-#### Solution:
+#### Solution
 
 There are three ways to work this out.
 
 1. To solve this issue, open the Terminal and run the following commands-
 
-```sh
-podman machine stop
-```
-
-and then,
-
-```sh
-podman machine start
-```
-
-2. If this does not work for you, you may proceed with the following commands-
-
-```sh
-podman machine rm
-```
+   ```shell-session
+   podman machine stop
+   podman machine start
+   ```
 
-and then,
+2. If this does not work for you, you might proceed with the following commands-
 
-```sh
-podman machine init
-```
+   ```shell-session
+   $ podman machine rm
+   $ podman machine init
+   ```
 
 3. If both of the abovementioned steps don't work for you, run the following commands-
 
-```sh
-rm -rf ~/.local/share/containers/podman
-```
-
-and then,
-
-```sh
-rm -rf ~/.config/containers/
-```
+   ```shell-session
+   $ rm -rf ~/.local/share/containers/podman
+   $ rm -rf ~/.config/containers/
+   ```
 
-After this, you can start off again by initializing a new Podman Machine and loading up the containers.
+   After this, you can start off again by initializing a new Podman Machine and loading up the containers.
 
 ### Unable to set custom binary path for Podman on macOS
 
-#### Issue:
+#### Issue
 
 When setting a custom binary path (under Preferences -> Custom binary path), Podman is unable to find `gvproxy` and `podman-mac-helper`:
 
 ```sh
 Error: unable to start host networking: "could not find \"gvproxy\" in one of [/usr/local/opt/podman/libexec /opt/homebrew/bin /opt/homebrew/opt/podman/libexec /usr/local/bin /usr/local/libexec/podman /usr/local/lib/podman /usr/libexec/podman /usr/lib/podman $BINDIR/../libexec/podman].  To resolve this error, set the helper_binaries_dir key in the `[engine]` section of containers.conf to the directory containing your helper binaries."
 ```
 
-#### Solution:
+#### Solution
 
 1. Download `gvproxy` from the [gvisor-tap-vsock release page](https://github.com/containers/gvisor-tap-vsock/releases).
 2. Build the `podman-mac-helper` from the source code on the [Podman GitHub page](https://github.com/containers/podman/tree/main/cmd/podman-mac-helper).
@@ -161,7 +146,7 @@ helper_binaries_dir=["/Users/user/example_directory"]
 
 ### Warning about Docker compatibility mode
 
-#### Issue:
+#### Issue
 
 When running the Podman provider, a warning shows regarding Docker compatibility mode on the dashboard:
 
@@ -174,7 +159,7 @@ This may appear when either:
 - The Docker socket is not mounted correctly
 - Docker Desktop is also being ran at the same time
 
-#### Solution:
+#### Solution
 
 **On macOS:**
 
@@ -239,7 +224,7 @@ This will stop the Podman Machine for you.
 
 If you are using an Apple Silicon and brew, you might encounter the following error when starting Podman from Podman Desktop
 
-```
+```shell-session
 Error: qemu exited unexpectedly with exit code 1, stderr: qemu-system-x86_64: invalid accelerator hvf
 qemu-system-x86_64: falling back to tcg
 qemu-system-x86_64: unable to find CPU model 'host'
@@ -260,9 +245,9 @@ Then run a terminal in native mode (default) and install Podman machine `brew in
 
 Finally clean the Podman machine VMs that had been previously created, and create new ones.
 
-```
-podman machine rm podman-machine-default
-podman machine init
+```shell-session
+$ podman machine rm podman-machine-default
+$ podman machine init
 ```
 
 You should be a happy camper from here.

website/package.json

@@ -36,6 +36,8 @@
     "@docusaurus/module-type-aliases": "2.4.0",
     "@tsconfig/docusaurus": "^1.0.7",
     "autoprefixer": "^10.4.14",
+    "markdownlint": "^0.28.2",
+    "markdownlint-cli2": "^0.7.1",
     "postcss": "^8.4.23",
     "tailwindcss": "^3.3.2",
     "typescript": "^5.0.4"