最近CodiMD というOSSを知った。
仕事でソフトウエアの設計書や、簡単な取り扱い説明を作ることが多いが
下記のような情報をもつ資料を作ろうとすると、WordやExcelを使うことになり、
結構ストレスを感じる。
- 説明文
- 画像( 画面ダンプ )
- UML図( シーケンス図やクラス図 )
この Qiita のエディタのような感覚で使える資料作成エディタがあればいいのだが。
ただ、Qiitaでもまだちょっと問題がある。
- 説明文 --> Markdownで快適
- 画像 --> 画面ダンプをとって、エディタにCtrl-Vで貼り付けられる
- UML図 --> これは無理なのかな。Qiitaに慣れていないので何とも。
- (追加課題) --> ネットワーク越しのせいか、気持ちエディタの反応が鈍い時がある
- (追加課題) --> 仕事の設計資料を全世界に公開するリスクがある( Trelloの件もあるし人為ミスも怖い)
CodiMDが便利そうだ
リンク : CodiMD
もともとは有償サービスのHachMDを模したOSSらしい。
ライセンスは AGPL なのでそのまま社内で使う分には問題なさそう。
Markdownベース
- 説明文 --> Markdownで快適
- 画像 --> 画面ダンプをとって、エディタにCtrl-Vで貼り付けられる
- UML図 --> 下でシーケンス図を紹介するがテキストベースでUML図を記述できる。
- ネットワーク --> 社内イントラ内なら遅くないだろう。自分用メモならローカルPCでも可。
- オンプレ構築だから社外流失事故も安心。
シーケンス図を描いてみた。
JavaScriptライブラリの種類があって、何通りかかけるようようだが、快適そう。
ほかにもすごいことが
PDFを出力できる。もう、WordやExcelをPDFにして客先提出とかいらなんじゃないか...
ちょっと残念なこと
PDF出力はベータ機能なのかいくつか問題がありました。
- Markdownの表に罫線がでない
- シーケンス図が 図のほうではなく、テキストを出力してしまう。
また、記事の検索については
- 自分が作った記事か、ほかの人が公開した記事のURLを直接みないと後で検索できない
- 検索は記事のタイトルだけ
あと、画像以外の添付ファイル( PDF とか Excelとか )をuploadできない。
このあたりが改善されると非常にいいツールになると思う。
とりあえず CodiMDを使ってみよう
Dockerを使うとあっという間に自分のPCにインストールできます。
[ 準備 ]
Windows10 にDocker for Windows]をインストールしておいてください。
最近は Windows10Proでなく Windows10Home でも Docker for Windows をインストールできるようになりました。
インストールの参考サイト
ほかにも様々な情報がネット上を検索すれば見つかるでしょう。
[ CodiMDのインストール方法 ]
CodiMDのサイトのインストール手順にある 下記の26行を docker-compose.ymlというファイルに保存します。
・(注1) 7行目と15行目は postgresqlのパスワードで適当に変えておいたほうが良いでしょう
・(注2) PDF出力で日本語を出したいときは 13行目を 2.2.0-cjk にしましょう。CodiMDのサイトのインストール手順にも記述があります。
・(注3) Linux上のdockerで動かす場合は、インストール手順のパーミッション設定をしないと画像をuploadできないのでご注意ください。
あとは Windowsのコマンドプロンプトで上記の docker-compose.yml のあるディレクトで下記を実行するだけ。
docker-compose up -d
初回起動だけ Dockerイメージのダウンロードで時間がかかりますが、下記のようにコンテナが2つ起動したら完了。
停止するときは stop です。
shell:docker-compose停止
docker-compose stop
これだけです。では http://localhost:3000/ にアクセスして CodiMDを堪能下さい。
最初は「サインイン」からユーザー登録して、改めて「サインイン」してください。
以上。