VuePress で一番辛いのは dev ではうまく言っているのに build するとうまく行かないことがあることです。これが一番辛いです。
VuePress に限った話では無く Vue でも同じなのかもしれないのですが、VuePress でしか使ったことがなく状況がわかりません。
本当に雑なのですが、以下、３点、記述いたします。
build と dev で生成される CSS の優先順位が変わることがあります。現在この問題に対して !important で対処しています。
components ディレクトリ配下で SFC を定義した時に scoped を付与しないと dev の時は scoped が付与されているような動作をするのですが build の時は scoped が外れた動作をします。
table タグの中で span を使って色付けすると、build 時に何故か JavaScript が例外を投げ動作しなくなることがある。