Astroでmarkdownの改行位置にbrタグを入れる方法


ブログを Astro を使って構築したが、自分が修正基として参考にしたAstroのテンプレートだと、markdownの改行位置にbrタグが自動で入らない設定となっていた。
これにより、markdown上で改行を1つ入れても改行されず、パラグラフが長くなり読みにくいという問題があった。
調べてみると、割と簡単に修正できることが分かった。

具体的な方法

remark-breaks というプラグインを追加することで解決できるらしい。

まずは、remark-breaksをnpmに追加する

npm install remark-breaks

その後、astro.config.mjs に下記のように設定を追加すれば良い

 export default defineConfig({
+       markdown: {
+               remarkPlugins: ['remark-breaks'], 
+               extendDefaultPlugins: true,
+         },
 });

参考サイト

以下のサイトを参考にさせていただいた。