LoginSignup
4
4

More than 3 years have passed since last update.

Org Mode + grip-mode で Github の README をきれいに書く

Last updated at Posted at 2020-01-20

リアルタイムにREADMEをプレビューしながら書きたい!

README.org だったり README.md だったり README.txt だったり色々ありますが、こいつらは改行やらスペースやらで稀に変な動作をすることがあります。

それに伴って、毎回変な update document とかの commit をしなければならないのは効率が悪いですし、コミットログが汚くなりますよね?

今回紹介するのは Emacs の grip-mode というパッケージです。これは Org-mode で書かれたファイルを Github のレンダリングでリアルタイムプレビューできる機能を提供してくれます。

例えばこんな感じ

ezgif-1-82261399a5ce.gif

インストール

package-install を導入している Emacs や Spacemacs (recommend) を使って M-x package-install grip-mode でインストールできます。

Spacemacs を使っている場合は、~/.spacemacsdotspacemacs-additional-packages に grip-mode を追加してください。

.spacemacs

     ;; List of additional packages that will be installed without being
     ;; wrapped in a layer. If you need some configuration for these
     ;; packages, then consider creating a layer. You can also put the
     ;; configuration in `dotspacemacs/user-config'.
     dotspacemacs-additional-packages '(
                                        grip-mode ;; Please Add here line
                                        )

4
4
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
4
4