macでインフォマティクス

macでインフォマティクス

HTS (NGS) 関連のインフォマティクス情報についてまとめています。

Pandocを使ってMarkdownをHTMLやword形式に変換する

 

マークダウンのビューアを持っていない人に向け、マークダウン記法で書かれた文書(例えばREADME.md)をPDFなどに変換してから送ることがあります。Pandocを使うとこの変換が簡単にできます。

 

User Guide

https://pandoc.org/MANUAL.html

 

Pandoc User’s Guide 日本語版

Pandoc User’s Guide 日本語版 — 日本Pandocユーザ会

 

Examples

https://pandoc.org/demos.html

 

インストール

Github

 

#conda (link)
mamba install -c conda-forge pandoc
mamba install -c conda-forge/label/cf201901 pandoc
mamba install -c conda-forge/label/cf202003 pandoc

pandoc -h

$ pandoc -h

pandoc [OPTIONS] [FILES]

  -f FORMAT, -r FORMAT  --from=FORMAT, --read=FORMAT                    

  -t FORMAT, -w FORMAT  --to=FORMAT, --write=FORMAT                     

  -o FILE               --output=FILE                                   

                        --data-dir=DIRECTORY                            

  -M KEY[:VALUE]        --metadata=KEY[:VALUE]                          

                        --metadata-file=FILE                            

  -d FILE               --defaults=FILE                                 

                        --file-scope                                    

  -s                    --standalone                                    

                        --template=FILE                                 

  -V KEY[:VALUE]        --variable=KEY[:VALUE]                          

                        --wrap=auto|none|preserve                       

                        --ascii                                         

                        --toc, --table-of-contents                      

                        --toc-depth=NUMBER                              

  -N                    --number-sections                               

                        --number-offset=NUMBERS                         

                        --top-level-division=section|chapter|part       

                        --extract-media=PATH                            

                        --resource-path=SEARCHPATH                      

  -H FILE               --include-in-header=FILE                        

  -B FILE               --include-before-body=FILE                      

  -A FILE               --include-after-body=FILE                       

                        --no-highlight                                  

                        --highlight-style=STYLE|FILE                    

                        --syntax-definition=FILE                        

                        --dpi=NUMBER                                    

                        --eol=crlf|lf|native                            

                        --columns=NUMBER                                

  -p                    --preserve-tabs                                 

                        --tab-stop=NUMBER                               

                        --pdf-engine=PROGRAM                            

                        --pdf-engine-opt=STRING                         

                        --reference-doc=FILE                            

                        --self-contained                                

                        --request-header=NAME:VALUE                     

                        --no-check-certificate                          

                        --abbreviations=FILE                            

                        --indented-code-classes=STRING                  

                        --default-image-extension=extension             

  -F PROGRAM            --filter=PROGRAM                                

  -L SCRIPTPATH         --lua-filter=SCRIPTPATH                         

                        --shift-heading-level-by=NUMBER                 

                        --base-header-level=NUMBER                      

                        --strip-empty-paragraphs                        

                        --track-changes=accept|reject|all               

                        --strip-comments                                

                        --reference-links                               

                        --reference-location=block|section|document     

                        --atx-headers                                   

                        --markdown-headings=setext|atx                  

                        --listings                                      

  -i                    --incremental                                   

                        --slide-level=NUMBER                            

                        --section-divs                                  

                        --html-q-tags                                   

                        --email-obfuscation=none|javascript|references  

                        --id-prefix=STRING                              

  -T STRING             --title-prefix=STRING                           

  -c URL                --css=URL                                       

                        --epub-subdirectory=DIRNAME                     

                        --epub-cover-image=FILE                         

                        --epub-metadata=FILE                            

                        --epub-embed-font=FILE                          

                        --epub-chapter-level=NUMBER                     

                        --ipynb-output=all|none|best                    

  -C                    --citeproc                                      

                        --bibliography=FILE                             

                        --csl=FILE                                      

                        --citation-abbreviations=FILE                   

                        --natbib                                        

                        --biblatex                                      

                        --mathml                                        

                        --webtex[=URL]                                  

                        --mathjax[=URL]                                 

                        --katex[=URL]                                   

                        --gladtex                                       

                        --trace                                         

                        --dump-args                                     

                        --ignore-args                                   

                        --verbose                                       

                        --quiet                                         

                        --fail-if-warnings                              

                        --log=FILE                                      

                        --bash-completion                               

                        --list-input-formats                            

                        --list-output-formats                           

                        --list-extensions[=FORMAT]                      

                        --list-highlight-languages                      

                        --list-highlight-styles                         

  -D FORMAT             --print-default-template=FORMAT                 

                        --print-default-data-file=FILE                  

                        --print-highlight-style=STYLE|FILE              

  -v                    --version                                       

  -h                    --help                                          

>

 

 

実行方法

markdownファイルを指定する。

 

Markdown => docx

pandoc -f markdown -t docx README.md > README.docx

 

Markdown => LaTeX

pandoc -f markdown -t latex README.md > README.tex

 

Markdown => jupyter-notebook

pandoc -f markdown -t ipynb README.md > README.ipynb

 

Markdown => HTML5

pandoc -f markdown -t html5 README.md > README.html

 

Markdown => PDF

pandoc -f markdown --pdf-engine=xelatex -t pdf README.md > README.pdf

 

HTML => Markdown

 pandoc -s -r html https://kazumaxneo.hatenablog.com -o kazumaxneo.md

  

引用

https://github.com/jgm/pandoc

 

参考