Add markdownlint config (#2880)

Add markdownlint config
ppy · Dec 4, 2019 · 95373b8 · 95373b8
2 parents 0dcab32 + 3bf518a
commit 95373b8
Show file tree

Hide file tree

Showing 16 changed files with 12 additions and 78 deletions.
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,12 @@
+{
+    "MD003": { "style": "atx" },
+    "MD004": { "style": "dash" },
+    "MD013": false,
+    "MD024": { "siblings_only": true },
+    "MD026": false,
+    "MD029": { "style": "ordered" },
+    "MD033": false,
+    "MD035": { "style": "---" },
+    "MD045": false,
+    "MD046": { "style": "fenced" }
+}
diff --git a/wiki/Article_Styling_Criteria/en.md b/wiki/Article_Styling_Criteria/en.md
@@ -700,9 +700,7 @@ British English spelling variants must be used when there are conflicting spelli
 - `skilful` instead of `skillful`
 - `analyse` instead of `analyze`
 
-<!-- markdownlint-disable MD026 -->
 ### osu!
-<!-- markdownlint-enable MD026 -->
 
 The name of the game, osu!, must not be capitalised or italicised. The osu! official branding must not use any spaces. Examples include:
 

diff --git a/wiki/Difficulties/en.md b/wiki/Difficulties/en.md
@@ -19,10 +19,7 @@ A beatmap's **difficulty** describes the level of skill needed to complete it. T
 
 These are the typical levels of difficulty that a beatmap can fall under. Specific definitions and requirements of each can be found in their respective mode's [ranking criteria](/wiki/Ranking_Criteria).
 
-<!-- markdownlint-disable MD045 -->
-<!-- markdownlint-disable MD026 -->
 ### ![](/wiki/shared/mode/osu.png) osu!
-<!-- markdownlint-enable MD026 -->
 
 - ![](/wiki/shared/diff/easy-s.png) Easy
 - ![](/wiki/shared/diff/normal-s.png) Normal
@@ -57,21 +54,18 @@ These are the typical levels of difficulty that a beatmap can fall under. Specif
 - ![](/wiki/shared/diff/insane-m.png) Insane
 - ![](/wiki/shared/diff/expert-m.png) Expert
 - ![](/wiki/shared/diff/expertplus-m.png) Expert+
-<!-- markdownlint-enable MD045 -->
 
 ## Star rating
 
 ![Star rating ranges](img/SR-range.png)
 
 On the website, beatmaps are automatically given a difficulty icon based on these star rating ranges:
 
-<!-- markdownlint-disable MD045 -->
 - ![](/wiki/shared/diff/easy-s.png) Easy: 0.0★–1.99★
 - ![](/wiki/shared/diff/normal-s.png) Normal: 2.0★–2.69★
 - ![](/wiki/shared/diff/hard-s.png) Hard: 2.7★–3.99★
 - ![](/wiki/shared/diff/insane-s.png) Insane: 4.0★–5.29★
 - ![](/wiki/shared/diff/expert-s.png) Expert: 5.3★–6.49★
 - ![](/wiki/shared/diff/expertplus-s.png) Expert+: 6.5★ and above
-<!-- markdownlint-enable MD045 -->
 
 Most maps' intended difficulty levels match the icons they are given, but some deviate significantly. This is why the [ranking criteria](/wiki/Ranking_Criteria) defines more precise rules for determining difficulty and evaluating beatmapset spreads.
diff --git a/wiki/Difficulties/fr.md b/wiki/Difficulties/fr.md
@@ -19,10 +19,7 @@ La difficulté d'une beatmap *décrit* le niveau de compétence requis pour pouv
 
 Ce sont les niveaux de difficulté typiques auxquels une beatmap peut être soumise. Les définitions spécifiques et les exigences de chacune se trouvent dans leurs modes respectifs de [ranking criteria](/wiki/Ranking_Criteria).
 
-<!-- markdownlint-disable MD045 -->
-<!-- markdownlint-disable MD026 -->
 ### ![](/wiki/shared/mode/osu.png) osu!
-<!-- markdownlint-enable MD026 -->
 
 - ![](/wiki/shared/diff/easy-s.png) Easy
 - ![](/wiki/shared/diff/normal-s.png) Normal
@@ -57,21 +54,18 @@ Ce sont les niveaux de difficulté typiques auxquels une beatmap peut être soum
 - ![](/wiki/shared/diff/insane-m.png) Insane
 - ![](/wiki/shared/diff/expert-m.png) Expert
 - ![](/wiki/shared/diff/expertplus-m.png) Expert+
-<!-- markdownlint-enable MD045 -->
 
 ## Star rating (difficulté en étoiles)
 
 ![Tranches de difficulté](img/SR-range.png)
 
 Sur le site web, les beatmaps ont automatiquement une icône de difficulté basé sur leur rang de star rating :
 
-<!-- markdownlint-disable MD045 -->
 - ![](/wiki/shared/diff/easy-s.png) Easy: 0.0★–1.99★
 - ![](/wiki/shared/diff/normal-s.png) Normal: 2.0★–2.69★
 - ![](/wiki/shared/diff/hard-s.png) Hard: 2.7★–3.99★
 - ![](/wiki/shared/diff/insane-s.png) Insane: 4.0★–5.29★
 - ![](/wiki/shared/diff/expert-s.png) Expert: 5.3★–6.49★
 - ![](/wiki/shared/diff/expertplus-s.png) Expert+: 6.5★ and above
-<!-- markdownlint-enable MD045 -->
 
 La plupart des difficultées de maps rentre dans les icônes donnés, mais certaines non. C'est pourquoi le [ranking criteria](/wiki/Ranking_Criteria) définie plus précisément les règles pour déterminer la difficulté et évaluer le beatmapset.
diff --git a/wiki/Guides/Videos_From_Youtube/en.md b/wiki/Guides/Videos_From_Youtube/en.md
@@ -19,8 +19,6 @@ This tutorial is intended for those who **can not** find the video elsewhere but
 
 [noTube](https://notube.net/) (there are many, many, MANY more out there but this one is listed).
 
-<!-- markdownlint-disable MD026 -->
 ### Loading video in osu!
-<!-- markdownlint-enable MD026 -->
 
 Open your beatmap and press `F2`, click Insert Background Video. Use the slider below to adjust the start time offset and voila, your done.
diff --git a/wiki/Guides/Videos_From_Youtube/fr.md b/wiki/Guides/Videos_From_Youtube/fr.md
@@ -15,8 +15,6 @@ Ce tutoriel est destiné pour ceux qui **ne peuvent pas** trouver la vidéo autr
 
 [noTube](https://notube.net/) (il y en a beaucoup, beaucoup, VRAIMENT beaucoup sur Internet mais on vous conseille celui-ci).
 
-<!-- markdownlint-disable MD026 -->
 ### Charger la vidéo sur osu!
-<!-- markdownlint-enable MD026 -->
 
 Lancez votre beatmap et appuyez sur `F2`, cliquez sur Insert Background Video. Utilisez la timeline à côté du bouton pour ajuster le temps auquel elle apparaît, et voilà, c'est fini !
diff --git a/wiki/Guides/Videos_From_Youtube/it.md b/wiki/Guides/Videos_From_Youtube/it.md
@@ -15,8 +15,6 @@ Questa guida è intesa per chiunque **non riesce** a trovare il video altrove ma
 
 [noTube](https://notube.net/) (ce ne sono molti, molti, MOLTI altri là fuori ma questo è elencato).
 
-<!-- markdownlint-disable MD026 -->
 ### Caricare il video in osu!
-<!-- markdownlint-enable MD026 -->
 
 Apri la tua beatmap e premi `F2`, clicca Video/Immagine di sfondo. Usa lo slider sotto per correggere l'offset di inizio video e voila, hai fatto.
diff --git a/wiki/Guides/Videos_From_Youtube/pt-br.md b/wiki/Guides/Videos_From_Youtube/pt-br.md
@@ -15,8 +15,6 @@ Este tutorial é destinado para aqueles que **não conseguem** encontrar o víde
 
 [noTube](https://notube.net/) (há muitos, muitos mais sites lá fora, mas este listado será o usado).
 
-<!-- markdownlint-disable MD026 -->
 ### Carregue o vídeo no osu!
-<!-- markdownlint-enable MD026 -->
 
 Abra o seu beatmap e pressione F2, clique em Insert Background Video. Use o barra deslizante abaixo para ajustar o deslocamento do tempo de início e voila, está pronto.
diff --git a/wiki/People/The_Team/Global_Moderation_Team/en.md b/wiki/People/The_Team/Global_Moderation_Team/en.md
@@ -16,7 +16,6 @@ The [Global Moderation Team group page](https://osu.ppy.sh/groups/4) lists all o
 
 *Note: All GMT members speak English in addition to the languages listed below, unless noted otherwise.*
 
-<!-- markdownlint-disable MD045 -->
 | Name | Additional languages | Area of focus |
 | :-- | :-- | :-- |
 | ![][flag_MY] [- [bibitaru] -](https://osu.ppy.sh/users/4482419) | Chinese, Malay | Chat moderation |
@@ -112,7 +111,6 @@ The [Global Moderation Team group page](https://osu.ppy.sh/groups/4) lists all o
 | `#thai` | [ภาษาไทย](https://osu.ppy.sh/community/forums/54) |  |
 | `#turkish` | [Türkçe](https://osu.ppy.sh/community/forums/93) | ![][flag_TR] [heyronii](https://osu.ppy.sh/users/5642779), ![][flag_TR] [Zeus-](https://osu.ppy.sh/users/5464437) |
 | `#vietnamese` |  |  |
-<!-- markdownlint-enable MD045 -->
 
 [flag___]: /wiki/shared/flag/__.gif
 [flag_AR]: /wiki/shared/flag/AR.gif

diff --git a/wiki/Ranking_Criteria/Difficulty_Naming/en.md b/wiki/Ranking_Criteria/Difficulty_Naming/en.md
@@ -8,10 +8,7 @@ These difficulty names are the most commonly used for each game mode.
 
 *Note: The special difficulty name **Marathon** historically allowed mappers to submit maps of longer songs, and thus became popular for single-difficulty mapsets. Today, the name has no special meaning and is typically only used for very long songs or song compilations.*
 
-<!-- markdownlint-disable MD045 -->
-<!-- markdownlint-disable MD026 -->
 ### osu!
-<!-- markdownlint-enable MD026 -->
 
 - ![](/wiki/shared/diff/easy-s.png) Easy
 - ![](/wiki/shared/diff/normal-s.png) Normal

diff --git a/wiki/Ranking_Criteria/osu!/en.md b/wiki/Ranking_Criteria/osu!/en.md
@@ -10,13 +10,11 @@ Rule proposals as well as suggestions are discussed in the [Ranking Criteria Sub
 
 *Main article: [Difficulty Naming](../Difficulty_Naming)*
 
-<!-- markdownlint-disable MD045 -->
 - ![](/wiki/shared/diff/easy-s.png) Easy
 - ![](/wiki/shared/diff/normal-s.png) Normal
 - ![](/wiki/shared/diff/hard-s.png) Hard
 - ![](/wiki/shared/diff/insane-s.png) Insane
 - ![](/wiki/shared/diff/expert-s.png) Expert
-<!-- markdownlint-enable MD045 -->
 
 ### Gameplay
 
@@ -87,9 +85,7 @@ Overall rules and guidelines apply to every kind of osu! difficulty. Rhythm-rela
 
 Difficulty-specific rules and guidelines do only apply to the difficulty level they are listed for and therefore *do not apply to **every** osu! difficulty*. Rhythm-related rules and guidelines apply to approximately 180 BPM beatmaps. If your song is drastically faster or slower, some variables might be different, as detailed in [Scaling BPM on the Ranking Criteria](/wiki/Ranking_Criteria/Scaling_BPM).
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/easy-s.png) Easy
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -118,9 +114,7 @@ Difficulty-specific rules and guidelines do only apply to the difficulty level t
 - Approach Rate should be 5 or less.
 - Overall Difficulty / HP Drain Rate should be between 1 and 3.
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/normal-s.png) Normal
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -158,9 +152,7 @@ If a Normal difficulty is required and used as the *lowest difficulty* of a beat
 - Approach Rate should be between 4 and 6.
 - Overall Difficulty / HP Drain Rate should be between 3 and 5.
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/hard-s.png) Hard
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -183,9 +175,7 @@ If a Normal difficulty is required and used as the *lowest difficulty* of a beat
 - Overall Difficulty should be between 5 and 7.
 - HP Drain Rate should be between 4 and 6.
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/insane-s.png) Insane
-<!-- markdownlint-enable MD045 -->
 
 #### Guidelines
 
@@ -201,9 +191,7 @@ If a Normal difficulty is required and used as the *lowest difficulty* of a beat
 - Overall Difficulty should be between 7 and 9.
 - HP Drain Rate should be between 5 and 8.
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/expert-s.png) Expert
-<!-- markdownlint-enable MD045 -->
 
 #### Guidelines
 

diff --git a/wiki/Ranking_Criteria/osu!catch/en.md b/wiki/Ranking_Criteria/osu!catch/en.md
@@ -10,13 +10,11 @@ These terms frequently appear when getting in touch with osu!catch difficulties
 
 *Main article: [Difficulty Naming](../Difficulty_Naming)*
 
-<!-- markdownlint-disable MD045 -->
 - ![](/wiki/shared/diff/easy-c.png) Cup
 - ![](/wiki/shared/diff/normal-c.png) Salad
 - ![](/wiki/shared/diff/hard-c.png) Platter
 - ![](/wiki/shared/diff/insane-c.png) Rain
 - ![](/wiki/shared/diff/expert-c.png) Overdose
-<!-- markdownlint-enable MD045 -->
 
 ### Gameplay
 
@@ -76,9 +74,7 @@ Overall rules and guidelines apply to every kind of osu!catch difficulty. Rhythm
 
 Difficulty-specific rules and guidelines do only apply to the difficulty level they are listed for and therefore *do not apply to **every** osu!catch difficulty*. Rhythm-related rules and guidelines apply to approximately 180 BPM beatmaps. If your song is drastically faster or slower, some variables might be different, as detailed in [Scaling BPM on the Ranking Criteria](/wiki/Ranking_Criteria/Scaling_BPM).
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/easy-c.png) Cup
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -96,9 +92,7 @@ Difficulty-specific rules and guidelines do only apply to the difficulty level t
 - HP Drain Rate should be 4 or less
 - Circle Size should be between 2-3
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/normal-c.png) Salad
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -122,9 +116,7 @@ Difficulty-specific rules and guidelines do only apply to the difficulty level t
 - HP Drain Rate should be between 4-5
 - Circle Size should be between 2.5-3.5
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/hard-c.png) Platter
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -153,9 +145,7 @@ Difficulty-specific rules and guidelines do only apply to the difficulty level t
 - HP Drain Rate should be between 5-6
 - Circle Size should be between 3-4
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/insane-c.png) Rain
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -177,9 +167,7 @@ Difficulty-specific rules and guidelines do only apply to the difficulty level t
 - HP Drain Rate should be between 6-7
 - Circle Size should be between 3-5
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/expert-c.png) Overdose
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 

diff --git a/wiki/Ranking_Criteria/osu!mania/en.md b/wiki/Ranking_Criteria/osu!mania/en.md
@@ -10,13 +10,11 @@ Rule proposals as well as suggestions are discussed in the [Ranking Criteria Sub
 
 *Main article: [Difficulty Naming](../Difficulty_Naming)*
 
-<!-- markdownlint-disable MD045 -->
 - ![](/wiki/shared/diff/easy-m.png) Easy
 - ![](/wiki/shared/diff/normal-m.png) Normal
 - ![](/wiki/shared/diff/hard-m.png) Hard
 - ![](/wiki/shared/diff/insane-m.png) Insane
 - ![](/wiki/shared/diff/expert-m.png) Expert
-<!-- markdownlint-enable MD045 -->
 
 ### Common terms
 
@@ -85,9 +83,7 @@ Difficulty-specific rules and guidelines do only apply to the difficulty level t
 
 *Key mode-specific guidelines are constructed based on the most common Ranked key modes (4 key and 7 key). Any other key modes should apply these guidelines when applicable.*
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/easy-m.png) Easy
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -106,9 +102,7 @@ Difficulty-specific rules and guidelines do only apply to the difficulty level t
 - **Avoid using chords during consecutive 1/2 note patterns.** However, using a chord to end a pattern is fine.
 - **Avoid chords with more than 2 notes.** This includes long note patterns that involve notes in more than two columns.
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/normal-m.png) Normal
-<!-- markdownlint-enable MD045 -->
 
 #### Rules
 
@@ -151,9 +145,7 @@ If a Normal difficulty is required and used as the *lowest difficulty* of a beat
 
 - **Consecutive 1/4 snaps should only be three notes long.** More dense rhythms are not appropriate for the lowest difficulty of a beatmapset.
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/hard-m.png) Hard
-<!-- markdownlint-enable MD045 -->
 
 #### Guidelines
 
@@ -187,9 +179,7 @@ If a Hard difficulty is required and used as the *lowest difficulty* of a beatma
 - **Chords within streams are discouraged.** The density of these patterns is often too difficult for players of this skill level, especially when used on the lowest difficulty of a beatmap set. However, using a chord at the beginning/end of a stream is fine.
 - **Short-term slider velocity changes should be used cautiously.** Changes should only happen for sections of different pacings and the slider velocity should not be drastically variable.
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/insane-m.png) Insane
-<!-- markdownlint-enable MD045 -->
 
 #### Guidelines
 
@@ -214,9 +204,7 @@ Additional guidelines for *7 key Insane* difficulties:
   - ...1/4, it's recommended to use a single note instead unless there is extremely clear musical justification.
 - **Bracket streams should be used sparingly.**
 
-<!-- markdownlint-disable MD045 -->
 ### ![](/wiki/shared/diff/expert-m.png) Expert
-<!-- markdownlint-enable MD045 -->
 
 #### Guidelines