Docs

mkdocs

自分のmkdocsのリポジトリ

ak1ra memo

git pushすると、travis ciで自動的に静的サイト生成＆gh-pagesブランチにpush

以下の .travis.ymlでmasterにpushされると自動的にgh-pagesブランチに置いてくれる

language: python

install:
  pip install -r requirements.txt

script:
  mkdocs build --verbose

deploy:
  provider: pages
  skip_cleanup: true
  github_token: $GITHUB_TOKEN
  local_dir: site
  on:
    branch: master

編集するところ

  • docs/ にmarkdownのwikiの内容
  • mkdocs.ymlにpagesを追加する

拡張機能について

参考

mkdocsについて

pandoc + Markdown

環境構築

Ubuntu 18.04 + VSCODE

sudo apt update
## Tex Packege
sudo apt install texlive-luatex texlive-xetex texlive-lang-japanese -y
sudo apt install texlive-lang-cjk
xdvik-ja evince texlive-fonts-recommended texlive-fonts-extra lmodern texlive-xetex -y
## Haskell
curl -sSL https://get.haskellstack.org/ | sh
## pandoc
stack install pandoc
stack install pandoc-citeproc
## pandoc-crossrefはstack installだとエラーのため以下で行う
git clone https://github.com/lierdakil/pandoc-crossref
cd pandoc-crossref
stack build --allow-different-user
stack install --allow-different-user

上記でVSCode上でmarkdownを編集して、pdfを生成できる

ディレクトリ構成

$ tree       
.
├── config.yml
├── imgs
│   ├── sample1.png
│   ├── sample2.png
│   └── sample3.png
├── makepdf.sh
├── myref01.bib
├── myref02.bib
├── paper.md
├── paper.pdf
├── sample.md
└── sample.pdf

pandocでmarkdown -> latexpdf生成のshell

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/bin/bash
CMDNAME=`basename $0`
if [ $# -ne 1 ]; then
  echo "Usage: $CMDNAME filename" 1>&2
  exit 1
fi

bibfiles=$(ls -F | grep bib)
echo 'bib files: '$bibfiles

pandoccmdtemplate='pandoc --pdf-engine=lualatex --toc -F pandoc-crossref -N -M "crossrefYaml=config.yml" -V documentclass=ltjarticle'
echo $pandoccmd
pandoccmd=''
for bib in ${bibfiles[@]}
do
  addbib=' --bibliography='${bib}
  pandoccmdtemplate+=${addbib}
done

pandoccmdtemplate+=' '
pandoccmdtemplate+=$1.md
pandoccmdtemplate+=' -o '
pandoccmdtemplate+=$1.pdf

echo $pandoccmdtemplate

echo $1.md to $1.pdf

${pandoccmdtemplate}

echo Done
  • --toc
  • 自動的に目次を生成
  • -N
  • 番号付き節ヘッダーをつける
  • --bibliography
  • 参照するファイルを読み取ってくれるが、変換前のmarkdownにbibのファイル名を書いても反応しない
  • 今回は、ls -F | grep bibでファイル名を取得して、ローカルの全.bibを適用させている
Failure

config.yamlが読み込まれておらず、figのままになっている

参考

https://qiita.com/Kumassy/items/5b6ae6b99df08fb434d9 https://qiita.com/SOhtsu/items/e921142372d0f4cce410 http://mickey-happygolucky.hatenablog.com/entry/2016/03/01/234228 https://qiita.com/Kenta11/items/5844df1a6a1f5f3ba6d5#pandoc-crossref https://qiita.com/sky_y/items/3c5c46ebd319490907e8 https://texwiki.texjp.org/?LuaTeX-ja#v06d4fe0