30 マークダウン (markdown) ことはじめ

(しばらく工事中)

遅ればせながらマークダウンを学び始める。 本来自分向きのような気がする (スタートが遅れたのは… 何のせい？)。 L^ATEX でものを書くことが多いが、 テキスト・ファイルでメモを書くことも良くあって、 そういうのは自然にマークダウンで書くように出来そうだ。

それはさておき。

• John Gruber が2004年に考案したドキュメントのフォーマット。
• HTML のようなマークアップ言語を念頭に考え出された。
• 「読み書きに特定のソフトウェが必要とせず、 文章構造を明示できる。」という説明がなされる。
  • 「文章構造を明示」とは、章立て、段落、箇条書き、列挙、 リンクなどができることを言っているのであろう。 HTML や L^ATEX を知っていると分かりやすい。 実際マークダウン形式のデータを HTML や L^ATEX に変換するソフトウェアがある。
  • 書くためにはテキスト・エディターがあれば良い。 これだけではマークアップ言語とも区別がつかないが、 特別なソフトウェアがなくても、自然に読めるのがミソなのだろう。 (個人的には、以前 H 君が書いていたドキュメントを思い出す。)
  • Jupyter ノートブックのマークダウン・セルでも使われている。
• ファイル名拡張子は .md である。
• Atom や Visual Studio Code では簡単にプリビューが出来る。
  (Atom ではそのまま出来た (shift+control+m でナヴィゲーション・ウィンドウが現れる)。 Visual Studio Code では、 パッケージをお勧めされてインストールした。emacs ではどうするのかなあ？)
• HTML に変換するには、例えば pandoc というコマンドが使える。

  pandocのインストール

  sudo port -N install pandoc
  

  マークダウンを HTML に変換

  pandoc なんとか.md -o かんとか.html
  

  とすると変換できる。節に番号を振るには

  マークダウンを(節に番号をつけた) HTML に変換

  pandoc -N なんとか.md -o かんとか.html
  

  とする。 Safari だと文字化けするけれど (Chrome, Firefox, w3m などでは文字化けしない)、先頭に

  kanji.txt

  <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF8">
  

  のように1行のおまじないを書いておくととりあえず文字化けせずに表示される。 自動化するには

  なんとか.md から なんとか.html への変換

  pandoc -N なんとか.md -o かんとか.html
  cat kanji.txt かんとか.html > なんとか.html
  

  とするのかな (きっと何か1行コマンドで済むのだろう)。
• L^ATEX に変換するにも pandoc が使える。

  pandoc なんとか.md -o かんとか.tex
  

  ただし、 “かんとか.tex” はそのままでは組版できない。 とりあえず

  なんとか.tex

  \documentclass[12pt,leqno,dvipdfmx]{jarticle}
  \AtBeginDvi{\special{pdf:tounicode EUC-UCS2}}
  \usepackage{hyperref}
  \newcommand{\tightlist}{}
  \begin{document}
  
  \input かんとか.tex
  
  \end{document}
  

  としたら出来た。
• PDF にするには…意外と大変だな。 「Markdown から pandoc で PDF ファイルを生成する」 に書いてあるおまじないをしたら出来た。

  pandoc -N --toc --toc-depth=2 なんとか.md -f markdown --pdf-engine=lualatex -V documentclass=ltjsarticle  -o なんとか.pdf
  

  lualatex？TEX を使うのね。そういえば MacPorts にこんなこと言われた。

    py39-nbconvert has the following notes:
      To convert markdown to formats other than HTML, nbconvert uses pandoc.
      Install it by running
  
      sudo port install pandoc
  
      To convert notebooks to PDF, nbconvert makes use of LaTeX and the XeTeX as
      the rendering engine. Install it by running
  
      sudo port install texlive-xetex
  

  texlive-xetex ってどのくらい大きいんだろう？ 自分は MacTeX をフルにインストールしてあるせいで何もしなくて良いのだけど、 TEX を使っていない人には敷居が高いのかなあ。

  nbconvert というのは

  jupyter nbconvert --to=python なんとか.ipynb
  

  のように使うらしい。そのうちやってみよう。

(2021/9/17追記) 日常的に L^ATEX を使っているので、 それを利用して PDF にするのが自然だろう。

md2pdf

#!/bin/sh
for i in "$@"
do
  name=${i%.md}
  pandoc -N $i -o ${name}0.tex
  cat ~/bin/md2latex.before ${name}0.tex ~/bin/md2latex.after > ${name}.tex
  pdfplatex ${name}.tex
done

~/bin/md2latex.before

\documentclass[12pt,leqno,dvipdfmx]{jarticle}
\AtBeginDvi{\special{pdf:tounicode EUC-UCS2}}
\usepackage{hyperref}
\newcommand{\tightlist}{}
\begin{document}

~/bin/md2latex.after

\end{document}

使い方

md2pdf なんとか.tex

これで なんとか.pdf が出来る。