Skip to content

Commit 4d05908

Browse files
committed
Adjusted markdownlint to agree with prettier and fixed markdown errors
1 parent 5cfe5bb commit 4d05908

File tree

5 files changed

+76
-49
lines changed

5 files changed

+76
-49
lines changed

.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ indent_size = 4
3030
# MARKDOWN Files
3131
[*.{md}]
3232
indent_style = space
33-
indent_size = 4
33+
indent_size = 4

.github/pull_request_template.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ PR will not be merged until all steps are complete.
2929

3030
If documentation does need updating either update it by creating a PR (preferred) or request a documentation update.
3131

32-
- User docs: https://github.com/GameServerManagers/LinuxGSM-Docs
33-
- Dev docs: https://github.com/GameServerManagers/LinuxGSM-Dev-Docs
32+
- User docs: <https://github.com/GameServerManagers/LinuxGSM-Docs>
33+
- Dev docs: <https://github.com/GameServerManagers/LinuxGSM-Dev-Docs>
3434

3535
**Thank you for your Pull Request!**

.markdownlint.json

+34-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,35 @@
11
{
2-
"MD013": false,
3-
"MD030": {
4-
"ul_single": 3,
5-
"ol_single": 1,
6-
"ul_multi": 3,
7-
"ol_multi": 1
8-
}
9-
}
2+
"no-duplicate-heading": false,
3+
"no-inline-html": {
4+
"allowed_elements": [
5+
"figure",
6+
"figcaption",
7+
"img",
8+
"p"
9+
]
10+
},
11+
"no-bare-urls": false,
12+
"comment": "The following entries disable rules that may conflict with Prettier see https://github.com/DavidAnson/markdownlint/blob/v0.34.0/style/prettier.json",
13+
"blanks-around-fences": false,
14+
"blanks-around-headings": false,
15+
"blanks-around-lists": false,
16+
"code-fence-style": false,
17+
"emphasis-style": false,
18+
"heading-start-left": false,
19+
"hr-style": false,
20+
"line-length": false,
21+
"list-indent": false,
22+
"list-marker-space": false,
23+
"no-blanks-blockquote": false,
24+
"no-hard-tabs": false,
25+
"no-missing-space-atx": false,
26+
"no-missing-space-closed-atx": false,
27+
"no-multiple-blanks": false,
28+
"no-multiple-space-atx": false,
29+
"no-multiple-space-blockquote": false,
30+
"no-multiple-space-closed-atx": false,
31+
"no-trailing-spaces": false,
32+
"ol-prefix": false,
33+
"strong-style": false,
34+
"ul-indent": false
35+
}

CONTRIBUTING.md

+33-32
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,32 @@ The following is a set of guidelines for contributing to LinuxGSM, which are hos
88

99
[Contributing to LinuxGSM](#contributing-to-linuxgsm)
1010

11-
- [Table of Contents](#table-of-contents)
12-
- [Code of Conduct](#code-of-conduct)
13-
- [🎉 Bug/Enhancement Contributions 🐛](#bug-enhancement-contributions)
14-
- [🐛Reporting Bugs](#reporting-bugs)
15-
- [Before Submitting A Bug Report](#before-submitting-a-bug-report)
16-
- [How Do I Submit A (Good) Bug Report?](#how-do-i-submit-a--good--bug-report-)
17-
- [🎉Suggesting Features](#suggesting-features)
18-
- [Before Submitting An Feature Suggestion](#before-submitting-an-feature-suggestion)
19-
- [How Do I Submit A (Good) Feature Suggestion?](#how-do-i-submit-a--good--feature-suggestion-)
20-
- [🎮 Game Server Requests](#game-server-requests)
21-
- [Before Submitting a Game Server Request](#before-submitting-a-game-server-request)
22-
- [How Do I Submit A (Good) Game Server Request?](#how-do-i-submit-a--good--game-server-request-)
23-
- [🎮 Game Server Specific Issues](#game-server-specific-issues)
24-
- [💻 Code Contributions](#code-contributions)
25-
- [Pull Requests](#pull-requests)
26-
- [Pull Request naming convention](#pull-request-naming-convention)
27-
- [Testing](#testing)
28-
- [Pull Request Status Checks](#pull-request-status-checks)
29-
- [Test Environment](#test-environment)
30-
- [:wine_glass: Styleguides](#-wine-glass--styleguides)
31-
- [Git Commit Messages](#git-commit-messages)
32-
- [BASH Styleguide](#bash-styleguide)
33-
- [:blue_book: Document Contributions](#-blue-book--document-contributions)
34-
- [Documentation Styleguide](#documentation-styleguide)
35-
- [Issue and Pull Request Labels](#issue-and-pull-request-labels)
11+
- [Contributing to LinuxGSM](#contributing-to-linuxgsm)
12+
- [Table of Contents](#table-of-contents)
13+
- [Code of Conduct](#code-of-conduct)
14+
- [🎉 Bug/Enhancement Contributions 🐛](#-bugenhancement-contributions-)
15+
- [🐛Reporting Bugs](#reporting-bugs)
16+
- [Before Submitting A Bug Report](#before-submitting-a-bug-report)
17+
- [How Do I Submit A (Good) Bug Report?](#how-do-i-submit-a-good-bug-report)
18+
- [🎉Suggesting Features](#suggesting-features)
19+
- [Before Submitting An Feature Suggestion](#before-submitting-an-feature-suggestion)
20+
- [How Do I Submit A (Good) Feature Suggestion?](#how-do-i-submit-a-good-feature-suggestion)
21+
- [🎮 Game Server Requests](#-game-server-requests)
22+
- [Before Submitting a Game Server Request](#before-submitting-a-game-server-request)
23+
- [How Do I Submit A (Good) Game Server Request?](#how-do-i-submit-a-good-game-server-request)
24+
- [🎮 Game Server Specific Issues](#-game-server-specific-issues)
25+
- [💻 Code Contributions](#-code-contributions)
26+
- [Pull Requests](#pull-requests)
27+
- [Pull Request naming convention](#pull-request-naming-convention)
28+
- [Testing](#testing)
29+
- [Pull Request Status Checks](#pull-request-status-checks)
30+
- [Test Environment](#test-environment)
31+
- [🍷 Styleguides](#-styleguides)
32+
- [Git Commit Messages](#git-commit-messages)
33+
- [BASH Styleguide](#bash-styleguide)
34+
- [:blue_book: Document Contributions](#blue_book-document-contributions)
35+
- [Documentation Styleguide](#documentation-styleguide)
36+
- [Issue and Pull Request Labels](#issue-and-pull-request-labels)
3637

3738
## Code of Conduct
3839

@@ -44,7 +45,7 @@ This project and everyone participating in it is governed by the [LinuxGSM Code
4445

4546
This section guides you through submitting a bug report for LinuxGSM. Following these guidelines help maintainers and the community understand your report 📝, reproduce the behaviour💻, and find any related reports 🔎.
4647

47-
Before creating bug reports, please check [this list](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#before-submitting-a-bug-report) as you might find out that you dont need to create one. When you are creating a bug report, please [include as many details as possible](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report). Fill out [the required template](<[https://github.com/GameServerManagers/LinuxGSM/issues/new/choose](https://github.com/GameServerManagers/LinuxGSM/issues/new/choose)>), the information it asks for helps us resolve issues faster.
48+
Before creating bug reports, please check [this list](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](https://github.com/GameServerManagers/linuxgsm/blob/master/CONTRIBUTING.md#how-do-i-submit-a-good-bug-report). Fill out [the required template](<[https://github.com/GameServerManagers/LinuxGSM/issues/new/choose](https://github.com/GameServerManagers/LinuxGSM/issues/new/choose)>), the information it asks for helps us resolve issues faster.
4849

4950
#### Before Submitting A Bug Report
5051

@@ -69,7 +70,7 @@ This section guides you through submitting a feature suggestion for LinuxGSM, in
6970

7071
#### Before Submitting An Feature Suggestion
7172

72-
- **Check the** [**documentation**](<https://docs.linuxgsm.com/%5D(https://docs.linuxgsm.com/)>) to confirm that the enhancement doesnt already exist.
73+
- **Check the** [**documentation**](<https://docs.linuxgsm.com/%5D(https://docs.linuxgsm.com/)>) to confirm that the enhancement doesn't already exist.
7374
- **Check your** [**LinuxGSM version**](https://docs.linuxgsm.com/commands/update-lgsm)**.** A newer version of LinuxGSM may already have your enhancement.
7475
- **Perform a** [**cursory search**](https://github.com/search?q=org:GameServerManagers%20type:issues&type=Issues) to see if the enhancement has already been suggested. If it has **and the enhancement is still open**, add a comment to the existing issue and give it a thumbs up instead of opening a new one.
7576

@@ -122,7 +123,7 @@ The process described here has several goals:
122123
Please follow these steps to have your contribution considered by the maintainers:
123124

124125
1. Follow all check-list in [the template](https://github.com/GameServerManagers/LinuxGSM/blob/master/.github/pull_request_template.md)
125-
2. Follow the [style guides](#styleguides)
126+
2. Follow the [style guides](#🍷 Styleguides)
126127
3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
127128

128129
What if the status checks are failing? If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
@@ -145,7 +146,7 @@ For example:
145146
- If applied, this commit will **release version 1.0.0**
146147
- If applied, this commit will **merge pull request #123 from user/branch**
147148

148-
Notice how this doesnt work for the other non-imperative forms:
149+
Notice how this doesn't work for the other non-imperative forms:
149150

150151
- If applied, this commit will **fixed bug with Y**
151152
- If applied, this commit will **change the behaviour of X**
@@ -154,9 +155,9 @@ Notice how this doesn’t work for the other non-imperative forms:
154155

155156
Below is an example of the subject line for a pull request:
156157

157-
**feat(alerts): add slack support to alerts**
158+
`feat(alerts): add slack support to alerts`
158159

159-
**fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround**
160+
`fix(csgoserver): remove SteamCMD auth requirement 32-bit workaround`
160161

161162
### Testing
162163

@@ -177,7 +178,7 @@ githubrepo="LinuxGSM"
177178
githubbranch="master"
178179
```
179180

180-
### :wine_glass: Styleguides
181+
### 🍷 Styleguides
181182

182183
#### Git Commit Messages
183184

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<p align="center">
2-
<a href="https://linuxgsm.com"><img src="https://i.imgur.com/Eoh1jsi.jpg" alt="LinuxGSM">
3-
<a href="https://www.codacy.com/gh/GameServerManagers/LinuxGSM/dashboard"><img src="https://img.shields.io/codacy/grade/d19c5234dc3743d8a8a14093711ca52d?style=flat-square&logo=codacy&logoColor=white" alt="Codacy grade"></a>
4-
<a href="https://bitbucket.org/GameServerManagers/linuxgsm"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/GameServerManagers/LinuxGSM/git-sync.yml?color=0052CC&logo=bitbucket&style=flat-square"></a>
5-
<a href="https://linuxgsm.com/discord"><img alt="Discord" src="https://img.shields.io/discord/127498813903601664?color=5865F2&label=%20&logo=discord&logoColor=ffffff&style=flat-square"></a>
6-
<a href="https://developer.valvesoftware.com/wiki/SteamCMD"><img src="https://img.shields.io/badge/SteamCMD-000000?style=flat-square&amp;logo=Steam&amp;logoColor=white" alt="SteamCMD"></a>
7-
<a href="https://github.com/GameServerManagers/LinuxGSM/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gameservermanagers/LinuxGSM?style=flat-square" alt="MIT License"></a>
2+
<a href="https://linuxgsm.com"><img src="https://i.imgur.com/Eoh1jsi.jpg" alt="LinuxGSM">
3+
<a href="https://www.codacy.com/gh/GameServerManagers/LinuxGSM/dashboard"><img src="https://img.shields.io/codacy/grade/d19c5234dc3743d8a8a14093711ca52d?style=flat-square&logo=codacy&logoColor=white" alt="Codacy grade"></a>
4+
<a href="https://bitbucket.org/GameServerManagers/linuxgsm"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/GameServerManagers/LinuxGSM/git-sync.yml?color=0052CC&logo=bitbucket&style=flat-square"></a>
5+
<a href="https://linuxgsm.com/discord"><img alt="Discord" src="https://img.shields.io/discord/127498813903601664?color=5865F2&label=%20&logo=discord&logoColor=ffffff&style=flat-square"></a>
6+
<a href="https://developer.valvesoftware.com/wiki/SteamCMD"><img src="https://img.shields.io/badge/SteamCMD-000000?style=flat-square&amp;logo=Steam&amp;logoColor=white" alt="SteamCMD"></a>
7+
<a href="https://github.com/GameServerManagers/LinuxGSM/blob/main/LICENSE"><img src="https://img.shields.io/github/license/gameservermanagers/LinuxGSM?style=flat-square" alt="MIT License"></a>
88
</p>
99

1010
[LinuxGSM](https://linuxgsm.com) is the command-line tool for quick, simple deployment and management of Linux dedicated game servers.

0 commit comments

Comments
 (0)