Merge pull request #2338 from jbampton/add-markdownlint

pre-commit: add `markdownlint` and clean Markdown files

Author: fpapon

.github/linters/.markdown-lint.yml

@@ -0,0 +1,34 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# MD013/line-length Line length
+MD013: false
+
+# MD014/commands-show-output Dollar signs used before commands without showing output
+MD014: false
+
+# MD033/no-inline-html Inline HTML
+MD033: false
+
+# MD034/no-bare-urls Bare URL used
+MD034: false
+
+# MD040/fenced-code-language Fenced code blocks should have a language specified
+MD040: false
+
+# MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading
+MD041: false

.pre-commit-config.yaml

@@ -47,6 +47,16 @@ repos:
         args: [--allow-missing-credentials]
       - id: detect-private-key
       - id: forbid-submodules
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.45.0
+    hooks:
+      - id: markdownlint
+        name: run markdownlint
+        description: check Markdown files with markdownlint
+        args: [--config=.github/linters/.markdown-lint.yml]
+        exclude: ^\.github/.*$
+        types: [markdown]
+        files: \.md$
   - repo: https://github.com/adrienverge/yamllint
     rev: v1.37.1
     hooks:

CONTRIBUTING.md

@@ -3,11 +3,11 @@ Contributing to Apache Shiro
 
 Summary
 -------
+
 This document covers how to contribute to the Apache Shiro project. These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to your own fork of the Apache Shiro project and you will submit a Pull Request for your changes to be added.
 
 _Let's get started!!!_
 
-
 Fork the code
 -------------
 
@@ -29,7 +29,6 @@ $ git fetch upstream
 $ git rebase upstream/main
 ```
 
-
 Making changes
 --------------
 
@@ -50,7 +49,6 @@ $ git commit -a -m "descriptive commit message for your changes"
 > The `-b` specifies that you want to create a new branch called `feature_x`.  You only specify `-b` the first time you checkout because you are creating a new branch.  
 > Once the `feature_x` branch exists, you can later switch to it with only `git checkout feature_x`.
 
-
 Rebase `feature_x` to include updates from `upstream/main`
 ------------------------------------------------------------
 
@@ -74,7 +72,6 @@ $ git rebase main
 
 > Now your `feature_x` branch is up-to-date with all the code in `upstream/main`.
 
-
 Make a GitHub Pull Request to contribute your changes
 -----------------------------------------------------
 
@@ -100,7 +97,6 @@ To initiate the pull request, do the following:
 If you are requested to make modifications to your proposed changes, make the changes locally on your `feature_x` branch, re-push the `feature_x` branch to your fork.  
 The existing pull request should automatically pick up the change and update accordingly.
 
-
 Cleaning up after a successful pull request
 -------------------------------------------
 

README.md

@@ -1,4 +1,4 @@
-[<img src="https://shiro.apache.org/images/apache-shiro-logo.png" align="right" />](https://shiro.apache.org)
+[<img src="https://shiro.apache.org/images/apache-shiro-logo.png" align="right" alt="Apache Shiro" />](https://shiro.apache.org)
 
 [![Maven Central](https://img.shields.io/maven-central/v/org.apache.shiro/shiro-core)](https://central.sonatype.com/artifact/org.apache.shiro/shiro-core/)
 [![Build Status](https://ci-builds.apache.org/buildStatus/icon?job=Shiro%2FShiro-all%2Fmain)](https://ci-builds.apache.org/job/Shiro/job/Shiro-all/job/main/)
@@ -12,13 +12,16 @@ Apache Shiro
 
 Documentation and Examples
 --------------------------
+
 https://shiro.apache.org
 
 Tutorials
 ---------
+
 * [10 Minute Tutorial](https://shiro.apache.org/10-minute-tutorial.html)
 * [Web Application](https://shiro.apache.org/webapp-tutorial.html)
 
 License
 -------
+
 [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)

samples/spring-boot/README.md

@@ -9,4 +9,3 @@ Run the Example
 ```
 mvn spring-boot:run
 ```
-