Always use fenced code block for markdown

wannier-developers · Jun 23, 2024 · e7c5b43 · e7c5b43
1 parent 55f6b0f
commit e7c5b43
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -18,3 +18,8 @@ MD033:
     - a
     - sup
     - code
+
+# MD046/code-block-style : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md046.md
+# for code blocks in list https://github.com/DavidAnson/markdownlint/issues/327
+MD046:
+  style: fenced
diff --git a/docs/docs/tutorials/tutorial_34.md b/docs/docs/tutorials/tutorial_34.md
@@ -2,10 +2,11 @@
 
 ## Outline
 
-Obtain MLWFs for graphene using projectability disentanglement. For more details
-on the methodology, see Ref.[@Qiao2023-pdwf].
+Obtain MLWFs for graphene using projectability disentanglement.
+For more details on the methodology, see Ref.[@Qiao2023-pdwf].
 
 ## Input files
+<!-- markdownlint-disable code-block-style -->
 
 - Directory: [`tutorial/tutorial34/`](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial34)
 

diff --git a/docs/docs/tutorials/tutorial_35.md b/docs/docs/tutorials/tutorial_35.md
@@ -3,10 +3,11 @@
 ## Outline
 
 Obtain MLWFs for silicon using projectability disentanglement, with additional
-$3d$ projectors to describe high-energy conduction bands. For more details on
-the methodology, see Ref.[@Qiao2023-pdwf].
+$3d$ projectors to describe high-energy conduction bands.
+For more details on the methodology, see Ref.[@Qiao2023-pdwf].
 
 ## Input files
+<!-- markdownlint-disable code-block-style -->
 
 - Directory: [`tutorial/tutorial35/`](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial35)