gitlab にアップロードする markdown ファイルの扱い方ベストプラクティスの募集

Question

私がいる最近始まったプロジェクトでは、gitlab にファイルやドキュメントをアップロードします。
ドキュメントはマークダウンで書いてあり、atomで編集しています。また、数式が含まれています。

atom で編集している md を gitlab に上げると、プレビューで上手く表示されません。
詳しくはまだ調べてないのですが、レンダリングの違いによります。

そこで、質問ですが良い解決方はありますでしょうか？
私が考えたのは
(1) 今まで通り atom で github markdown で編集し、アップロードするとき変換する正規表現プログラムを書き、それを通してアップロードする。ただプログラムを書くのも、毎回プログラムを通すのも面倒です。
(2) atom で gitlab markdown に対応する数式パッケージを探し、それをいれる。このパッケージが存在するかは分かりません。よろしければ教えて下さい。
(3) gitlab markdown に対応したエディタを探す。プレビューがあると嬉しいです。もしご存知でしたら教えて下さい。

何か良い解決方があれば教えて下さい。よろしくお願いいたします。

Comments

[退会済みユーザー]

編集中のMarkdown、どのコードは本来どのように表示されているのか。また、アップロード後はそのコードの部分がどのように表示されないのか。スクリーンショットなどの実例があると非常にわかりやすいと思います。また、GitLabはOSSを自社サーバーで使用しているのかそれともWebサービスを使用しているのかによっても異なるかと思います。

Answer 1

gitlab の数式レンダリングは KaTex で、github の数式レンダリングは MathJax でした。
gitlab で見れるドキュメントの編集のための、atom での KaTex でのレンダリングのプレビューに対応したパッケージを探しました。探した結果 markdown-preview-enhanced が要件に対応しているようでした。
設定で KaTex と MathJax の切り替えができます(!)

今まで markdown-preview-plus を使っていましたが、これに乗り換えました。おすすめだと思います。

あいまいな質問でしたらすみませんでした。
ご回答ありがとうございました。

Answer 2

GitLabのmarkdownに合わせて書くしかないのでは。
あとはGitLab上で直接編集するとか。それならプレビューできる。

Comments

[spectrum]

ありがとうございます。 gitlab 上で編集できることは知りませんでした。