Markdown fixes

.github/workflows/ci.yml

@@ -11,6 +11,17 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  markdownlint-cli:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Run markdownlint-cli
+        uses: nosborn/[email protected]
+        with:
+          files: .
+          config_file: ".markdownlint.yaml"
+
   build:
     name: Build
     runs-on: ubuntu-22.04

.markdownlint.yaml

@@ -2,5 +2,4 @@
 default: true
 line-length: false
 
-# MD033/no-inline-html Inline HTML
 MD033: false

BENCHMARKING.md

@@ -6,7 +6,7 @@ This guide contains some information on how to benchmark `erldns` locally.
 
 The recommended benchmarking tool is [`dnsperf`](https://github.com/DNS-OARC/dnsperf). You can compile it from source or, if on macOS, install it with:
 
-```bash
+```shell
 brew install dnsperf
 ```
 
@@ -48,7 +48,7 @@ Then, start the release in the foreground:
 
 Now you're ready to run benchmarks. For example:
 
-```bash
+```shell
 dnsperf -p 8053 -d ./queries.txt -T 4 -c 20 -n 10000
 ```
 
@@ -77,7 +77,7 @@ www.example.com. CNAME
 <details>
 <summary>Command</summary>
 
-```bash
+```shell
 dnsperf -p 8053 -d ./queries.txt -T 4 -c 20 -n 10000
 ```
 

CONTRIBUTING.md

@@ -4,7 +4,7 @@ erldns is an open source project licensed under an MIT license. Contributions ar
 
 ## Getting started
 
-#### 1. Clone the repository
+### 1. Clone the repository
 
 Clone the repository and move into it:
 
@@ -13,23 +13,23 @@ git clone [email protected]:dnsimple/erldns.git
 cd erldns
 ```
 
-#### 2. Install Erlang
+### 2. Install Erlang
 
-#### 3. Create your own working branch
+### 3. Create your own working branch
 
 ```shell
 git checkout -b dev_new_feature_xyz
 ```
 
-#### 4. Build and test
+### 4. Build and test
 
 Compile the project and [run the test suite](#testing) to check everything works as expected.
 
 ```shell
 make all
 ```
 
-#### 5. Adding local (checkout) dependencies for rebar3
+### 5. Adding local (checkout) dependencies for rebar3
 
 Please follow the instructions available at
 <https://www.rebar3.org/docs/configuration/dependencies/>
@@ -54,15 +54,15 @@ erldns includes several test mechanisms.
 
 To execute unit tests (and dialyzer for static analysis):
 
-```
+```shell
 make test
 ```
 
 ### Functional Testing
 
 The [dnstest](https://github.com/dnsimple/dnstest) tool provides a suite of black-box functional tests for erldns (and any other DNS authoritative name server). The tests are largely based on the excellent [suite of tests](https://github.com/PowerDNS/pdns/tree/master/regression-tests/tests) in [PowerDNS](http://powerdns.com). To run the tests, you must change `erldns.config` so that zones are loaded from `priv/zones-test.json`.
 
-```
+```erlang
 [
   {erldns, [
     {zones, "priv/zones-test.json"}
@@ -76,7 +76,7 @@ Then you will need to run erldns. At this point it should be ready to test with
 
 If your editor doesn't automatically format Erlang code using [erlfmt](https://github.com/WhatsApp/erlfmt), run:
 
-```bash
+```shell
 make format
 ```
 

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2024 DNSimple Corporation
+# Copyright (c) 2012-2024 DNSimple Corporation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -5,21 +5,21 @@ Serve DNS authoritative responses... with Erlang.
 [![CI](https://github.com/dnsimple/erldns/actions/workflows/ci.yml/badge.svg)](https://github.com/dnsimple/erldns/actions/workflows/ci.yml)
 [![GitHub version](https://badge.fury.io/gh/dnsimple%2Ferldns.svg)](https://badge.fury.io/gh/dnsimple%2Ferldns)
 
-# Requirements
+## Requirements
 
 Erlang/OTP 27+
 
 ## Building
 
 To build:
 
-```
+```shell
 make
 ```
 
 To start fresh:
 
-```
+```shell
 make fresh
 make
 ```
@@ -36,21 +36,21 @@ An example configuration file can be found in `erldns.example.config`. Copy it t
 
 ## Running
 
-### Launch directly:
+### Launch directly
 
-```bash
+```shell
 overmind start
 ```
 
-### To get an interactive Erlang REPL:
+### To get an interactive Erlang REPL
 
-```bash
+```shell
 ./rebar3 shell
 ```
 
-### Build a distribution with and run the release:
+### Build a distribution with and run the release
 
-```bash
+```shell
 ./rebar3 release
 ./_build/default/rel/erldns/bin/erldns foreground
 ```
@@ -155,7 +155,7 @@ There is an administrative API for querying the current zone cache and for basic
 
 To run automated tests:
 
-```bash
+```shell
 make test
 ```