Parmをためす

今日、下記ブログでmarkdown形式でSphinxっぽくHTMLを生成できるツールがあるということを知ったので試してみる
- http://www.moongift.jp/2014/01/parm-%E5%A4%A7%E5%9E%8B%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E3%81%AB%E3%82%82%E5%AF%BE%E5%BF%9C%E3%81%A7%E3%81%8D%E3%82%8Bmarkdown%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3/
SphinxはreST(reStructuredText)記法を覚えないと行けないので、markdownで書けるってのはとても魅力的！
公式サイト：http://limodou.github.io/parm/

インストール

pythonとpipが入っていれば簡単
当然、pythonの環境ぐらい入ってますよね？笑
```
  sudo pip install par
  sudo pip install parm
```
以上。簡単。

まずは、使ってみる

作成先のディレクトリにフォルダを作成する。今回はデスクトップに作成してみる
```
 cd Desktop/
 mkdir parmTest
```
ディレクトリに移動
```
 cd parmTest/
```
テンプレートを生成する
```
 parm init
```

質問に答えて、テンプレートの初期設定をしていく。

 //プロジェクトの名前を決める
 Project name [Parm]: myFirstParm

 //Copyrightを決める
 Copyright information [2013, Limodou]: 2014,michi

 //バージョンを指定
 Version [1.1]:

 //CSSのテーマを設定
 Choice theme (bootstrap, semantic) [semantic]:

 //Disqusにアップする場合のアカウント名？
 Disqus account name []:

 //検索ボックスを入れるか
 If you want to add search input(Y/n)[Y]:

 //検索でつかうドメイン名
 Domain name used for search []:

 //ファイル生成
 {'template_dirs': 'templates', 'domain': '', 'copyright': '2014,michi', 'search': True, 'project': 'myFirstParm', 'theme': 'semantic', 'version': '1.1', 'disqus': ''}
 Copy theme/semantic/templates to ./templates
 Copy init files [index.md*](Y/n)[Y]:
 Copy templates/env/index.md to ./index.md
 Copy templates/env/introduction.md to ./introduction.md
 Copy templates/env/exclude.txt to ./exclude.txt

本番のHTML生成
```
 Parm make
```
みてみる

ちなみに、ソースはこんな感じ

  Parm Introduction
  ==================

  What's this
  ------------

  This documention is just for demo, you need to replace it with you real docs.

自分でも作ってみる

mkdir parmTest2
cd parmTest2/
parm init

Project name [Parm]: my second parm
Copyright information [2013, Limodou]: 2014,michi
Version [1.1]: 0.1
Choice theme (bootstrap, semantic) [semantic]:
Disqus account name []:
If you want to add search input(Y/n)[Y]:
Domain name used for search []:
{'template_dirs': 'templates', 'domain': '', 'copyright': '2014,michi', 'search': True, 'project': 'my second parm', 'theme': 'semantic', 'version': '0.1', 'disqus': ''}
Copy theme/semantic/templates to ./templates
Copy init files [index.md*](Y/n)[Y]:
Copy templates/env/index.md to ./index.md
Copy templates/env/introduction.md to ./introduction.md
Copy templates/env/exclude.txt to ./exclude.txt

こんな感じで作りました。
- フォルダはこんな感じ生成される。

index.mdに含めるmarkdownファイルの一覧を記述する

  ## fitbitって良いよ！
  {% toc max_depth=1 %}
  fitbit.md
  {% endtoc %}
  ## Parmをためす
  {% toc max_depth=1 %}
  parm.md
  {% endtoc %}

makeする。makeした後のフォルダは下記の通り

生成されるHTMLをみてみる

フォルダ構造
index
中身
- コードもいい感じにシンタックスハイライトされてる

ハマったこと

Bootstrapのテーマが動かない
- bootstrapのテーマの方はあんまりいい感じに動かなかった・・・。
- ドキュメントに下記のようにあったから、安定していないのだろう。

About theme¶

For 0.8 version, parm is already support two themes: bootstrap, semantic. But I prefer the semantic, because I made more care about it. If you want to change the theme, you can just change :

#を使って見出しを作っていると、markdownファイルからHTMLへの変換に失敗する
- markdownファイルの見出しの記法は#と====があるが、#だとコケた
- 下記のようなエラーになってしまった・・・
  - Error: Heading 1 not found in file parm.md
  - ERROR:root:File parm.md can't be found, will be skipped
- ====こっちの記法で書き直したら動いた。んー。
左ペインの項目は------で見出しを付けた項目になる
検索窓がうまいこと動かない・・・

感想

やっぱり、SphinxのreSTよりもmarkdownの方が扱いやすいので、parmを使っていこうかと思う。
- markdownの方がエディタも豊富だしね
ちょうどSphinxを使い始めようかと思ったが、やめた！笑

どらちゃんのポッケ

R・統計・技術メモなど勉強ログ置き場

markdown形式のファイルをSphinxっぽく出力できるParmを試す

Parmをためす

インストール

まずは、使ってみる

自分でも作ってみる

生成されるHTMLをみてみる

ハマったこと

感想