fix: fix markdownlint violations, switch to jsonc config with comments

Signed-off-by: Gregor Zeitlinger <gregor.zeitlinger@grafana.com>

Author: zeitlinger

.markdownlint.jsonc

@@ -1,10 +1,6 @@
 {
   // Line length — pre-existing across docs, README, benchmarks
   "MD013": false,
-  // Fenced code blocks without surrounding blank lines — pre-existing
-  "MD031": false,
   // Inline HTML — needed for badge images in README
-  "MD033": false,
-  // Emphasis used as heading — pre-existing in docs/content
-  "MD036": false
+  "MD033": false
 }

docs/content/_index.md

@@ -13,12 +13,14 @@ The main new features of the 1.0.0 release are:
 - **Runtime configuration:** Configure metrics, exporters, and more at runtime using a properties
   file or system properties.
 
+<!-- markdownlint-disable-next-line MD036 -->
 **Documentation and Examples**
 
 In addition to this documentation page we created an
 [examples/](https://github.com/prometheus/client_java/tree/main/examples) directory with end-to-end
 scenarios (Docker compose) illustrating new features.
 
+<!-- markdownlint-disable-next-line MD036 -->
 **Performance Benchmarks**
 
 Initial performance benchmarks are looking great: All core metric types (including native
@@ -27,6 +29,7 @@ that utilizes all processor cores in parallel the metrics library will not intro
 synchronization. See Javadoc comments in
 [benchmarks/](https://github.com/prometheus/client_java/tree/main/benchmarks) for benchmark results.
 
+<!-- markdownlint-disable-next-line MD036 -->
 **More Info**
 
 The Grafana Labs Blog has a post
@@ -37,6 +40,7 @@ There will also be a presentation at the [PromCon](https://promcon.io) conferenc
 Tune in to the live stream on [https://promcon.io](https://promcon.io)
 or watch the recording on YouTube.
 
+<!-- markdownlint-disable-next-line MD036 -->
 **For users of the 0.16.0 version and older**
 
 Updating to the 1.0.0 version is a breaking change. However, there's a

docs/content/config/config.md

@@ -92,6 +92,7 @@ When the same property is defined in multiple sources, the following precedence
 
 <!-- editorconfig-checker-enable -->
 
+<!-- markdownlint-disable-next-line MD036 -->
 **Notes**
 
 (1) _withExemplars()_ and _withoutExemplars()_ are available for all metric types,

docs/content/getting-started/metric-types.md

@@ -127,6 +127,7 @@ The default bucket boundaries are designed for measuring request durations in se
 use cases, you may want to define custom bucket boundaries. The histogram builder provides three
 methods for this:
 
+<!-- markdownlint-disable-next-line MD036 -->
 **1. Arbitrary Custom Boundaries**
 
 Use `classicUpperBounds(...)` to specify arbitrary bucket boundaries:
@@ -139,6 +140,7 @@ Histogram responseSize = Histogram.builder()
     .register();
 ```
 
+<!-- markdownlint-disable-next-line MD036 -->
 **2. Linear Boundaries**
 
 Use `classicLinearUpperBounds(start, width, count)` for equal-width buckets:
@@ -151,6 +153,7 @@ Histogram queueSize = Histogram.builder()
     .register();
 ```
 
+<!-- markdownlint-disable-next-line MD036 -->
 **3. Exponential Boundaries**
 
 Use `classicExponentialUpperBounds(start, factor, count)` for exponential growth:

examples/example-exporter-servlet-tomcat/README.md

@@ -66,12 +66,15 @@ browser:
    from [https://github.com/prometheus/prometheus/releases](https://github.com/prometheus/prometheus/releases). <!-- editorconfig-checker-disable-line -->
 2. Extract the archive
 3. Edit `prometheus.yml` and append the following snippet at the end:
+
    ```yaml
    job_name: "tomcat-servlet-example"
    static_configs:
      - targets: ["localhost:8080"]
    ```
+
 4. Run with native histograms and exemplars enabled:
+
    ```shell
    ./prometheus --enable-feature=native-histograms --enable-feature=exemplar-storage
    ```