From 1a513a914dfbfcce097caa4ceeb8859d25bb22fa Mon Sep 17 00:00:00 2001 From: Alessio Biancalana Date: Tue, 19 Aug 2025 19:23:28 +0200 Subject: [PATCH] docs: fix markdown lint (#1815) * docs: add MD025 and MD059 to disabled linting rules * chore: fix markdown for bug report template * docs: ignore linting for a very specific, tricky doc link --- .github/ISSUE_TEMPLATE/bug_report.md | 11 ++++++----- .markdownlint.yaml | 2 ++ docs/useful_tips.md | 1 + 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 37cdd530..123caf12 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -27,11 +27,12 @@ Run the commands with `--verbose` and post the log here as a file upload Attach also the output of `podman logs` or `docker logs`, possibly with `--latest` flag **Desktop (please complete the following information):** - - Are you using podman, docker or lilipod? - - Which version or podman, docker or lilipod? - - Which version of distrobox? - - Which host distribution? - - How did you install distrobox? + +- Are you using podman, docker or lilipod? +- Which version or podman, docker or lilipod? +- Which version of distrobox? +- Which host distribution? +- How did you install distrobox? **Additional context** Add any other context about the problem here. diff --git a/.markdownlint.yaml b/.markdownlint.yaml index 171fca0e..a1ee23ec 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -5,6 +5,8 @@ MD013: tables: false headings: false headers: false +MD025: false MD033: false MD041: false MD045: false +MD059: false diff --git a/docs/useful_tips.md b/docs/useful_tips.md index 1af90a25..696d58c8 100644 --- a/docs/useful_tips.md +++ b/docs/useful_tips.md @@ -9,6 +9,7 @@ - [Duplicate an existing distrobox](#duplicate-an-existing-distrobox) - [Export to the host](#export-to-the-host) - [Execute commands on the host](#execute-commands-on-the-host) + - [Resolve "Error cannot open display: :0"](#resolve-error-cannot-open-display-0) - [Using init system inside a distrobox](#using-init-system-inside-a-distrobox) - [Using Docker inside a Distrobox](#using-docker-inside-a-distrobox)