Merge pull request #314 from pankona/markdownlint

Introduce markdownlint to fix and prevent `fenced-code-language`
pankona · Sep 17, 2024 · a631ff9 · a631ff9
2 parents 3f5ee28 + 1274ff8
commit a631ff9
Show file tree

Hide file tree

Showing 19 changed files with 54 additions and 26 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -8,6 +8,10 @@ updates:
       nix:
         patterns:
           - 'DeterminateSystems*'
+    ignore:
+      # They do not support specifying a version in the latest action. Therefore, we need to pin the version for nixpkgs compatibility.
+      # See https://github.com/DavidAnson/markdownlint-cli2-action/issues/94 for detail
+      - dependency-name: 'DavidAnson/markdownlint-cli2-action'
   - package-ecosystem: 'gomod'
     directory: '/'
     schedule:

diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -27,3 +27,12 @@ jobs:
           dprint-version: 0.45.0
       - name: Debug print for deprint target paths
         run: dprint output-file-paths
+
+  markdownlint:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: DavidAnson/markdownlint-cli2-action@3aaa38e446fbd2c288af4291aa0f55d64651050f # v12
+        with:
+          globs: '**/*.md'
diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml
@@ -0,0 +1,3 @@
+config:
+  default: false
+  MD040: true # fenced-code-language
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -6,5 +6,6 @@
     "tekumara.typos-vscode",
     "dprint.dprint",
     "jnoortheen.nix-ide",
+    "davidanson.vscode-markdownlint"
   ]
 }
diff --git a/Makefile b/Makefile
@@ -27,3 +27,4 @@ deps:
 	nil --version
 	peco --version
 	vim --version | sed -n '1p'
+	markdownlint-cli2 --version | grep 'markdownlint v'
diff --git a/content/posts/arch-windows-multiboot-tips.md b/content/posts/arch-windows-multiboot-tips.md
@@ -39,7 +39,7 @@ Windows8.1に対してWindows Updateしたところ、何だかわからない
 -- genfstab とかそういったことをこまごま行う。
 -- ブートローダのインストール。ブートローダにはgummibootを採用した。
 
-```
+```bash
 mount /dev/sda2 /boot/EFI
 cd /boot/EFI
 gummiboot install
@@ -62,7 +62,7 @@ Vaioのせいなのか、Windowsのせいなのか。。
 
 -- まず、EFIのパーティションをマウントする。
 
-```
+```bash
 mount /dev/sda2 /mnt/boot/EFI
 ```
 

diff --git a/content/posts/decorate-git-command-in-alpine.md b/content/posts/decorate-git-command-in-alpine.md
@@ -22,7 +22,7 @@ Alpine Linux で git を使うと、色々気に食わないことが起こる
 
 less を入れる。
 
-```
+```bash
 sudo apk add less
 ```
 
@@ -35,7 +35,7 @@ Refs: https://wiki.alpinelinux.org/wiki/Alpine_Linux:FAQ#How_to_enable.2Ffix_col
 
 曰く、
 
-```
+```plaintext
 The problem is not in git itself or terminal, but in the less command. Busybox’s less doesn’t support -r (--raw-control-chars) and -R (--RAW-CONTROL-CHARS) options.
 The simplest (yet not ideal) solution is to install GNU less:
 apk add less

diff --git a/content/posts/dokusho-meter.md b/content/posts/dokusho-meter.md
@@ -33,7 +33,7 @@ Octopressに読書メーターのブログパーツを追加する方法。
 中身は上記ブログパーツの内容をコピペしたものだが。
 ブログパーツとして「最近読んだ本」をチョイス。
 
-```
+```html
 <section>
 <a href="http://book.akahoshitakuya.com/u/{人によって違うID}" title="{人の名前}の最近読んだ本"><img src="http://img.bookmeter.com/bp_image/640/509/{人によって違うID}.jpg" border="0" alt="{人の名前}の最近読んだ本"></a>
 </section>
@@ -43,10 +43,18 @@ Octopressに読書メーターのブログパーツを追加する方法。
 
 _config.ymlのdefault_asidesを変更。読書メーター用HTMLファイルを指定。
 
-```
-default_asides: [custom/asides/about.html, asides/recent_posts.html, asides/github.html, asides/delicious.html, 
-                 asides/pinboard.html, asides/googleplus.html, custom/asides/tag_cloud.html, custom/asides/category_list.html,
-                 custom/asides/dokusho_meter.html]
+```yaml
+default_asides: [
+  custom/asides/about.html,
+  asides/recent_posts.html,
+  asides/github.html,
+  asides/delicious.html,
+  asides/pinboard.html,
+  asides/googleplus.html,
+  custom/asides/tag_cloud.html,
+  custom/asides/category_list.html,
+  custom/asides/dokusho_meter.html,
+]
 ```
 
 #### deployしたら完了

diff --git a/content/posts/droidkaigi-2018-3.md b/content/posts/droidkaigi-2018-3.md
@@ -104,7 +104,7 @@ func (t *t) Show(text string) error {
 
 ちゃんとどのようなエラーが (4) で吐かれているか補足してみたところ、以下の例外が投げられていた。
 
-```
+```plaintext
 java.lang.RuntimeException: Can't create handler inside thread that has not called Looper.prepare()
 ```
 

diff --git a/content/posts/github-action-is-disabled-if-no-activity-in-the-repo.md b/content/posts/github-action-is-disabled-if-no-activity-in-the-repo.md
@@ -11,7 +11,7 @@ GitHub から「更新のないリポジトリで使ってる定期実行 GitHub
 
 GitHub 曰く、
 
-```
+```plaintext
 Scheduled workflows are disabled automatically after 60 days of repository inactivity
 ```
 

diff --git a/content/posts/golangtokyo-14.md b/content/posts/golangtokyo-14.md
@@ -33,7 +33,7 @@ goroutine と defer と panic を組み合わせて使う場合に注意すべ
 たとえば以下のような場合、A 内で張った defer は呼び出されない**場合がある**。
 (スライド内では"呼び出されない"と書かれているが、その限りではなさそうな)
 
-```
+```go
 func A() {
     defer func(){}()
     go B()

diff --git a/content/posts/golangtokyo-16.md b/content/posts/golangtokyo-16.md
@@ -29,7 +29,7 @@ Go 言語も wasm へのビルド (トランスパイル) を Go 1.11 からサ
 
 たとえば以下のいわゆるハローワールド的なコードも wasm 向けにビルドできるようになる。
 
-```
+```go
 package main
 
 import "fmt"
@@ -42,7 +42,7 @@ func main() {
 wasm 向けのビルドは以下のようなコマンドで行う。
 (上記のソースが main.go として存在していると仮定)
 
-```
+```console
 $ GOOS=js GOARCH=wasm go build -o hello.wasm main.go
 ```
 
@@ -53,7 +53,7 @@ GitHub に curl を飛ばしても取得できる。
 
 ビルドと必要なファイルを揃える処理を一式 Makefile で書くと以下のような感じになる。
 
-```
+```makefile
 WASM = test.wasm
 HTML = wasm_exec.html
 JS   = wasm_exec.js
@@ -76,7 +76,7 @@ clean:
 
 一式そろうと以下のようになる。
 
-```
+```console
 $ ls
 main.go  Makefile  server.go  test.wasm  wasm_exec.html  wasm_exec.js
 ```

diff --git a/content/posts/golangtokyo-6.md b/content/posts/golangtokyo-6.md
@@ -38,7 +38,7 @@ https://www.slideshare.net/takuyaueda967/gopher-fest-2017
 型にエイリアスが張れるようになるとのこと。
 以下のような書き方ができるようになる。
 
-```
+```go
 type Applicant = http.Client
 ```
 
@@ -49,7 +49,7 @@ type Applicant = http.Client
 
 (パターン1) 新しい型を作って順次移行する場合
 
-```
+```go
 type Applicant Client
 ```
 
@@ -58,7 +58,7 @@ type Applicant Client
 
 (パターン2) 埋め込みを使う場合
 
-```
+```go
 type Applicant struct { Client }
 ```
 

diff --git a/content/posts/jp-input-on-gnome-app.md b/content/posts/jp-input-on-gnome-app.md
@@ -30,15 +30,15 @@ dconf Editor を開き、以下の設定を確認する。
 
 コマンドラインから確認する場合は以下のように入力する。
 
-```
+```console
 $ gsettings get org.gnome.settings-daemon.plugins.xsettings overrides
 # (期待される出力) {'Gtk/IMModule': <'fcitx'>}
 ```
 
 入ってなかったら、上記の値をコピペして設定する。
 コマンドラインから設定する場合は以下のように入力する。
 
-```
+```console
 $ gsettings set org.gnome.settings-daemon.plugins.xsettings overrides "{'Gtk/IMModule':<'fcitx'>}"
 ```
 

diff --git a/content/posts/raspi-livestream-web.md b/content/posts/raspi-livestream-web.md
@@ -26,7 +26,7 @@ pacmanであったりyaourtで取得できるmjpg-streamerのパッケージは
 下記のような。とりあえずサンプルなので、簡単に。。
 書いたHTMLは、任意の場所におく。ここではひとまず、`~/www/index.html`として置いたとする。
 
-```
+```html
 <html>
   <body>
     <h1>Raspberry Pi</h1>

diff --git a/content/posts/usb-wifi-dongle.md b/content/posts/usb-wifi-dongle.md
@@ -39,7 +39,7 @@ WN-AC433UM は、idVendor が 04BB、idProduct が 0959 であるが、
 os_dep/linux/usb_intf.c に、以下のように追記する。
 (注: 妥当か不明だがとりあえず以下の書き換えでうまくいった)
 
-```
+```patch
 diff --git a/os_dep/linux/usb_intf.c b/os_dep/linux/usb_intf.c
 index 5a62f24..7138a26 100644
 --- a/os_dep/linux/usb_intf.c
@@ -57,7 +57,7 @@ index 5a62f24..7138a26 100644
 
 ビルドし、インストールする。
 
-```
+```console
 $ cd rtl8192eu-linux-driver
 $ make
 $ sudo make install

diff --git a/content/posts/use-uim-mozc.md b/content/posts/use-uim-mozc.md
@@ -39,7 +39,7 @@ Arch Linux向けです。
 
 .xinitrcに以下を追記。uimを使う設定ですな。
 
-```
+```bash
 # uim
 export GTK_IM_MODULE='uim'
 export QT_IM_MODULE='uim'

diff --git a/content/posts/wsl2-uses-cpu-100-percent.md b/content/posts/wsl2-uses-cpu-100-percent.md
@@ -22,7 +22,7 @@ categories: ["Linux"]
 
 具体的には、`%userprofile%.wslconfig` というファイルを作って以下の内容を書き込む。WSL2 を再起動すれば設定が適用される。
 
-```
+```ini
 [wsl2]
 guiApplications=false
 ```

diff --git a/flake.nix b/flake.nix
@@ -40,6 +40,8 @@
               hugo
               go_1_22
               dart-sass
+
+              markdownlint-cli2
             ];
           };