parent 9d5dc500e6

author Sylvestre Ledru <sylvestre@debian.org> 1677865358 +0100
committer Sylvestre Ledru <sylvestre@debian.org> 1677951797 +0100

md: Fix a bunch of warnings in the docs

docs/src/build.md

@@ -1,3 +1,3 @@
 # Build from source
 
-{{#include ../../README.md:build }}
+{{#include ../../README.md:build }}

docs/src/contributing.md

@@ -1 +1,3 @@
-{{ #include ../../CONTRIBUTING.md }}
+<!-- markdownlint-disable MD041 -->
+
+{{ #include ../../CONTRIBUTING.md }}

docs/src/index.md

@@ -1,5 +1,9 @@
+<!-- markdownlint-disable MD041 -->
+
 {{#include logo.svg}}
 
+<!-- markdownlint-disable MD033 -->
+
 <style>
     /* Make the logo a bit bigger and center */
     #logo {

docs/src/installation.md

@@ -11,6 +11,7 @@ You can also [build uutils from source](/build.md).
 <!-- toc -->
 
 ## Cargo
+
 [![crates.io package](https://repology.org/badge/version-for-repo/crates_io/uutils-coreutils.svg)](https://repology.org/project/uutils-coreutils/versions)
 
 ```bash
@@ -23,6 +24,7 @@ cargo install coreutils --features windows
 ```
 
 ## Linux
+
 ### Alpine
 
 [![Alpine Linux Edge package](https://repology.org/badge/version-for-repo/alpine_edge/uutils-coreutils.svg)](https://pkgs.alpinelinux.org/packages?name=uutils-coreutils)
@@ -62,6 +64,7 @@ emerge -pv sys-apps/uutils-coreutils
 ```
 
 ### Manjaro
+
 ![Manjaro Stable package](https://repology.org/badge/version-for-repo/manjaro_stable/uutils-coreutils.svg)
 [![Manjaro Testing package](https://repology.org/badge/version-for-repo/manjaro_testing/uutils-coreutils.svg)](https://repology.org/project/uutils-coreutils/versions)
 [![Manjaro Unstable package](https://repology.org/badge/version-for-repo/manjaro_unstable/uutils-coreutils.svg)](https://repology.org/project/uutils-coreutils/versions)
@@ -73,6 +76,7 @@ pamac install uutils-coreutils
 ```
 
 ### NixOS
+
 [![nixpkgs unstable package](https://repology.org/badge/version-for-repo/nix_unstable/uutils-coreutils.svg)](https://repology.org/project/uutils-coreutils/versions)
 
 ```bash
@@ -80,6 +84,7 @@ nix-env -iA nixos.uutils-coreutils
 ```
 
 ### OpenMandriva Lx
+
 [![openmandriva cooker package](https://repology.org/badge/version-for-repo/openmandriva_cooker/uutils-coreutils.svg)](https://repology.org/project/uutils-coreutils/versions)
 
 ```bash
@@ -101,6 +106,7 @@ export PATH=/usr/lib/cargo/bin/coreutils:$PATH
 ## MacOS
 
 ### Homebrew
+
 [![Homebrew package](https://repology.org/badge/version-for-repo/homebrew/uutils-coreutils.svg)](https://formulae.brew.sh/formula/uutils-coreutils)
 
 ```bash
@@ -108,6 +114,7 @@ brew install uutils-coreutils
 ```
 
 ### MacPorts
+
 [![MacPorts package](https://repology.org/badge/version-for-repo/macports/uutils-coreutils.svg)](https://ports.macports.org/port/coreutils-uutils/)
 
 ```
@@ -115,6 +122,7 @@ port install coreutils-uutils
 ```
 
 ## FreeBSD
+
 [![FreeBSD port](https://repology.org/badge/version-for-repo/freebsd/uutils-coreutils.svg)](https://repology.org/project/uutils-coreutils/versions)
 
 ```sh
@@ -124,6 +132,7 @@ pkg install uutils
 ## Windows
 
 ### Scoop
+
 [![Scoop package](https://repology.org/badge/version-for-repo/scoop/uutils-coreutils.svg)](https://scoop.sh/#/apps?q=uutils-coreutils&s=0&d=1&o=true)
 
 ```bash
@@ -136,4 +145,6 @@ scoop install uutils-coreutils
 
 [![AUR package](https://repology.org/badge/version-for-repo/aur/coreutils-hybrid.svg)](https://aur.archlinux.org/packages/coreutils-hybrid)
 
-A GNU coreutils / uutils coreutils hybrid package. Uses stable uutils programs mixed with GNU counterparts if uutils counterpart is unfinished or buggy.
+A GNU coreutils / uutils coreutils hybrid package. Uses stable uutils
+programs mixed with GNU counterparts if uutils counterpart is
+unfinished or buggy.

docs/src/multicall.md

@@ -1,4 +1,5 @@
-#  Multi-call binary
+# Multi-call binary
+
 uutils includes a multi-call binary from which the utils can be invoked. This
 reduces the binary size of the binary and can be useful for portability.
 
@@ -12,6 +13,7 @@ coreutils [util] [util options]
 The `--help` flag will print a list of available utils.
 
 ## Example
-```
+
+```shell
 coreutils ls -l
-```
+```

docs/src/test_coverage.md

@@ -1,5 +1,7 @@
 # GNU Test Coverage
 
+<!-- markdownlint-disable MD033 -->
+
 uutils is actively tested against the GNU coreutils test suite. The results
 below are automatically updated every day.