弊社技術ドキュメントのMarkdown化(その1)

弊社専務が技術文書は全部Markdownにしようと言い出した。Githubを使うんでGithubに置くドキュメントはどっちみちMarkdownのものも作るわけで、特に外部から様式が指定されていないものは、全部Markdownを最終目標で作成することになる。

ちまちま環境を作ってきたので、小出しで書いていこうと思う。

VS CodeのMarkdown対応

オレも専務も現在のメインのエディタはVS Codeである。割と使いやすいし、軽めだし、Extensionが充実しているので何かと都合がいい。

大学の研究室で稼働しているThinkPad W530が一番色々インストールが進んでいるのだが、自宅のメインマシンThinkPad W540は64bit版に上げたのでちょっとどのExtensionを入れればいいのかわからない。そこでコマンドで比較。

C:\Users\shigeo-t>code --list-extensions
chenxsan.vscode-standard-format
esbenp.prettier-vscode
GrapeCity.gc-excelviewer
mkloubert.vscode-remote-workspace
MS-CEINTL.vscode-language-pack-ja
ms-python.python
ms-vscode.powershell
octref.vetur
redhat.java
shd101wyy.markdown-preview-enhanced
VisualStudioExptTeam.vscodeintellicode
vscjava.vscode-java-debug
vscjava.vscode-java-dependency
vscjava.vscode-java-pack
vscjava.vscode-java-test
vscjava.vscode-maven
yzhang.markdown-all-in-one

この2つだった。早速インストール。

 Google DriveのMarkdown対応

 弊社内で閉じる技術ドキュメントはGoogle Driveに置くのだが、いいツールがあった。StackEdit である。WebでGoogle Driveを開いて、.mdファイルを右クリック。アプリとして選択できる。

 Visual Studio Codeと同じように左右に並ぶ。Markdownの表の記述も再現できている。

新規で追加するときは下記サイトを参照頂きたい。アンインストールしてインストール手順を書くのがめんどくさくなったので手抜きである。

使い分けだが、ちょっと直すくらいの時はStackEdit、ガッツリ直すとか追加していくときはVS Codeって感じ。やっぱりちょっとStackEditだと重いし。

Google Drive上の画像ファイル表示

Google DriveをWebで表示している時、画像ファイルのリンクを取得しても、そのままでは使えない。

http://docs.google.com/file/d/{FILEID}/edit:title

これを

http://drive.google.com/uc?export=view&id={FILEID}

に直せば表示できる。StackEditだと変換がめんどくさいので、VS Codeに複数の画像ファイルURLを貼り、一括で変換しちゃう。 

----

まだ色々ツールを入れ始めているので、それはまた別途。

はじめてのMarkdown―軽量マークアップ言語の記法と使い方 (I・O BOOKS)

Web制作者のためのGitHubの教科書 チームの効率を最大化する共同開発ツール Web制作者のための教科書シリーズ