Markdownを独自拡張してWordドキュメントを卒業する
こんにちはCTOの馬場です。 このたび納品ドキュメント作成で永らく使っていたWordを卒業し、 Markdownで書いてPDFで納める活動を始めたので公開します。 Wordを使っていると並行編集作業できない、改訂履歴追跡が難しいなどの課題があり、その解決のためにいろいろ模索してこの形になりました。 この仕組みには、こんなイイところがあります。 Markdownで書ける gitで差分管理、版管理される GitLab のマージリクエスト(GitHubで言うところのPull Request)を使ってレビュー・リリース管理できる GitLab CIで自動ビルドされる GitLab CI + Jenkinsで自動デプロイされる 以下のツール群を利用しています。 GitLab MkDocs HEARTBEATS Flavored Markdown extension wkhtmltopdf Jenki
Monod - オフラインファーストなMarkdownエディタ
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました MarkdownエディタはWeb、GUIともに増えています。インストール不要で使える分、Webベースのが便利だとは思うのですが、厄介なのはネットワークがない時です。そんな時に使えないのでは使う気が失せてしまうでしょう。 そこで使ってみたいのがMonodです。Webベースですが、オフラインファーストなMarkdownエディタです。 Monodの使い方 Monodの画面です。2ペインのよくあるMarkdownエディタです。絵文字をサポートしています。 テンプレート機能があり、YAMLフォーマットでテンプレートが使えます。 例えばprojectとして定義すれば、[project]の部分が書き換わります。 MonodはReact.jsを使って作られています。そうした点も注目に値するのではな
MarkDownDiagram - Markdown風記法を使ってダイアグラム作成
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました Markdownが流行ると、Markdown風の記法を用いることでユーザの導入障壁を下げることができます。また、パーサーも多いのでそうしたライブラリを使うことで簡単にMarkdown風の記法が使えるようになります。 今回紹介するMarkDownDiagramもそんなMarkdown風記法を使ったソフトウェアの一つです。ダイアグラムをテキストで書けます。 MarkDownDiagramの使い方 メイン画面です。左側のエディタ部を編集すると右側のダイアグラムに反映されます。 ブロックという文字に変更してみました。 ブロックの位置はドラッグ&ドロップで変更できます。 線の色や太さを変えることもできます。 ズームもできます。 MarkDownDiagramを使えばダイアグラムを作成するのが
Boostnote - オンラインでシェアもできるMarkdownベースのメモ帳
メモ環境は大事です。気がついた時にさっとメモをしておけば、後々見返すこともできます。かつメモ環境はなるべく一カ所に統一しておくのが大事です。個人的には適当なテキストファイルに書き込んでいます。 しかし個人的にBoostnoteに集中させようと思っています。それくらい使い勝手のいいソフトウェアです。 Boostnoteの使い方 メイン画面です。 フォルダ、メモ一覧そしてメモと3段階の構成になっています。メモにはタグがつけられます。 新しいメモを作成しました。 メモはMarkdownで記入できます。 編集時はAceエディタを使っているので見やすいです。 Boostnoteの面白いのはメモをシェアできる機能があることで、専用の7日間のURLが生成されます。ローカルでメモを書いて、必要があればオンラインで共有できます。検索機能も便利なのでぜひ使ってみてください。 BoostnoteはElectro
Markdown風テキストでダイアグラムが描けるWebツール - Qiita
MarkDownDiagram Markdown風のテキストで、ER図やブロックダイアグラムのようなチャートを描けるツールです。 こちらにインスパイアされて、もうちょっと汎用的にダイアグラムを描けるツールを作りました。 もう保守されない画面遷移図は嫌なので、UI Flow図を簡単にマークダウンぽく書くエディタ作った 特徴としては Webブラウザのみでローカルで動作 配置はマウスでドラッグして編集できる CSSで色や装飾を制御可能 といったあたりです。 githubからclone/ダウンロードして使えます。 オンラインで試すのはこちらでどうぞ。 ローカルでブラウザのみで動作します。index.htmlをブラウザで開いてください。 Chrome推奨ですが、Safari,Firefoxでも動作します。タッチIFは未対応。 機能 テキストでブロックを記述し、ブロック間を線で繋ぐ描画 ブロックをマウ
ProseMirror - Markdownで記入できるWYSIWYGエディタ
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました WYSIWYGエディタは多数ありますが、基本HTMLを作成するためのツールです。HTMLに不慣れな非エンジニアにとっては便利ですが、ある程度技術力がある人にとってはツールの使い勝手によってストレスが感じられるでしょう。 今回は次世代的なWYSIWYGとも言えるProseMirrorを紹介します。記法はMarkdown、描画はHTMLというソフトウェアです。 ProseMirrorの使い方 こちらがProseMirrorの画面です。HTMLが描画されていますが、記法としてはMarkdownが使えます。 リンクなどは別途ツールが表示されて、そこでURLを入力できます。 画像の埋め込み表示にも対応しています。 ツールバーではなくツールチップモードも用意されています。 メニューから機能を辿
HackMD – Markdownのコラボレーションエディタ
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました Markdownを使ってドキュメントを作ることが増えていますが、規模の大きなドキュメントになると一人で作るよりも複数人で分担作業することのが多いように思います。 文書を分割する手もありますが、HackMDを使ってオンラインコラボレーションしながらドキュメントを作ってみるのはいかがでしょうか。 HackMDの使い方 HackMDではログイン、または匿名ユーザとして利用できます。 サイドバイサイドの表示です。左側がエディタ、右側がプレビューです。 編集内容はリアルタイムで反映されます。 別なブラウザから見たところ。カーソルがあるところに印が出ています。 エディタだけを最大化したところ。 プレビューのみ。編集しない場合はこちらでも良さそうです。 見出しの折りたたみ機能があります。 右側に
mdast-lint - Markdown記法チェッカー
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました MarkdownはHTMLを知らなくとも手軽に書ける記法ですが、見た目とHTMLとしての結果がリンクしていないのでレンダリングした結果、思っていたのと違ったということも少なくありません。 そこで使ってみたいのがmdast-lintです。記法上のミスやMarkdownで記述するためのより良い書き方が確認できるはずです。 mdast-lintの使い方 mdast-lintはnpmを使ってインストールができます。クライアントサイドのJavaScriptにも対応しているのでBowerでもインストールできます。 $ npm install -g mdast-lint 使い方としては -u で mdast-lint を指定し、ファイル名を指定します。 $ mdast -u mdast-lint
Markdownテキストでシーケンス図とフローチャートを描く - Qiita diagram sequence
つい先日、とあるシステムの処理の流れと一部処理のフローチャートを付けた見積り資料を書くことになり、ちょうど良い機会だったので、MarkdownでUML図表が描ける「StackEdit」を使って、オールMarkdownで資料を作成してみた。 いやぁ、打ち込んだテキストがリアルタイムに図表化されていく様は、とても新鮮で、そしてすごく面白かった。資料が出来上がった後の達成感というか、完成した図表を見た時の感動が結構はんぱない。技術系の資料作成でこんな良い体験ができたのは初めてかもしれんな…(笑) ──と、結構感動的な体験ができるMarkdownでのUML図表作成なんだが、せっかくなのでそれの書き方を含めてもう少し突っ込んだTIPSとしてまとめておこうかと思った次第。 Markdown+UML とは？ とりあえず、「Markdown+UML」というのは私の造語だ。まぁ、正確に言うなら「UML di
MacDown – Mouに似たMac OSX用のMarkdownエディタ
Markdownが様々な場面で使われるようになっているので、そろそろ専用エディタが欲しいと感じている人も多いのではないでしょうか。幾つかのエディタがありますが、今回はその最新とも言えるエディタを紹介します。 これまで出てきているソフトウェアの良いところを踏まえつつ進化していく、それがMac OSX用のMarkdownエディタMacDownです。 MacDownの使い方 MacDownはMouにインスパイアされて開発されているようです。エクスポートはHTMLのみとなっています。エディタ部のデフォルトが黒背景なのが書きやすくていい感じではないかと思います。 MacDownはMac OSX用、MIT Licenseのオープンソース・ソフトウェアです。 MacDown: The open source Markdown editor for OS X. uranusjr/macdown
本を読む reveal.jsを使ってMarkdownでプレゼン
ほぼ自分用メモ。 やりたいこと reveal.jsを使うと、スライドをMarkdownで書いて、変換とかなしでKeynoteとかみたく切り換えエフェクトを付けてプレゼンできる ただし、ぜんぶMarkdownで書く場合はhttp:〜で読み込む必要がある（HTMLで書いた場合や、ページ単位のMarkdownで書いた場合は、file:〜でよい） 追加ソフトのインストールなしにreveal.jsとMarkdownでプレゼンしたい 準備 reveal.jsはgitで入手しておく（https://github.com/hakimel/reveal.js/）gitでブランチを切る「reveal.js+Markdown - Qiita」あたりを参考に、index.htmlからMarkdownのスライドを読み込むようにする Markdownでスライドを書く。ページの区切りは「---」で前後空行、ところどころ
脱GitHub初心者を目指す人のREADMEマークダウン使いこなし術 | ゆっくりと…
README がキチッと書かれているプロジェクトって、どんなに小さくても立派に見えますよネ。 GitHub の場合、大抵はマークダウン記法で書かれた README.md とか README.markdown とかいう名前のファイルが、HTML に変換 （マークアップ） されて表示されていることはご存知でしょう。 マークダウン記法自体はとても簡単なのですが、GitHub では GitHub Flavored Markdown （略して GFM） という GitHub 用にアレンジされたマークダウン・エンジンが採用されていて、一般のマークダウン・エディタでチェックしてからコミットしても、意図通りの見た目にならないことが多々あります。私 （もちろん GitHub 初心者です！） の場合、README ファイルだけで10回以上もコミットしてしまいました。「マークアップ （レンダリング） を気にして
Collaborative Markdown - コラボレーション機能付き。WebベースのMarkdownエディタ MOONGIFT
最近流行のMarkdownエディタ。ローカルアプリケーションあり、Web版ありと様々なエディタが存在します。個人で書く分には様々な選択肢から選べば良いですが、みんなで文書を一緒に編集するとなると選択肢は限られるでしょう。 そんな時に欲しいのはWebベースでコラボレーションできるソフトウェアではないでしょうか。リアルタイムなコラボレーションをサポートしたCollaborative Markdownを紹介します。 Collaborative Markdownの使い方 画面を見て分かる通り、2ペインに分かれた構成になっています。これは良くある形式ですね。 日本語も書けます。プレビューはリアルタイムに反映されます。 さらにコラボレート。左側に接続している人の一覧が出ます。 コラボレーション中のデータもリアルタイムに反映されますので、複数人で一気に文書を作り上げるのも簡単です。保存もその場で行われま
markdownfmt·Markdown記法を見やすく統一！ MOONGIFT
同じ結果が得られるとしても、プログラミングの組み方によってその内容は千差万別です。しかし会社でプログラミングする際などにはそのようなスキルによって書き方が大きく違うというのは厄介でしょう。 Markdownについてもそれは同じで、例えば見出しの書き方すら2種類用意されており、好みによって利用が異なっています。これでは折角統一したフォーマットの利便性が活かせないかも知れません。そこで使ってみたいのがmarkdownfmtです。 markdownfmtのインストール markdownfmtはgofmtのMarkdown版とも言うべきソフトウェアです。インストールはgoコマンドで簡単にできます。 $ go get -u github.com/shurcooL/markdownfmt インストールするとmarkdownfmtコマンドが使えるようになります。 $ markdownfmt --help
Markdownでスライドを作る決定版！「Deckset」が非常に良かった話 - 5.1さらうどん
スライドを作りたい photo by James Jordan 勉強会に出席するような意識の高い読者諸賢であれば、各々様々な方法でスライドを作っているかと思います。 僕は、markdownを使って楽にカッコイイスライドを作ろうと、今までいろいろ試行錯誤してきたのですが、どれも僕の要求を満たすような感じではなくて、結局Keynoteを使ってせっせとスライドを作っていました。 Decksetが凄く良い Markdownからスライドショーを生成してくれる「Deckset」というMac用のアプリを2000円も出して買ってみたのですが、凄く良かったのでご紹介します。 https://itunes.apple.com/jp/app/deckset-turn-your-notes-into/id847496013?mt=12&uo=4&at=10l8JW&ct=hatenablog Deckset fo
ditto - Markdownを使ったAPIドキュメント生成
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 読みやすいAPIドキュメントはどういった形でしょうか。様々なソフトウェアが出ていますが、抜群にこれ！といったものにはまだ出会っていません。多機能なものもあれば、シンプルなもの、各言語向けにそれぞれドキュメントフォーマットも異なるのが面倒ですらあります。 しかしまずドキュメントの入力記法を統一しておけば、後から見た目の変更をするのもさほど難しくはないはずです。そこでMarkdownを利用する上で使ってみたいのがdittoです。 dittoの使い方 dittoはGitHub Pageで使うことも想定して作られています。そのためオープンソースのGitHubページとして使うと便利そうです。またビルドプロセスはなく、Markdownを修正すれば良いだけで、手軽に使えます。後はJavaScri
Markdown Slides - Markdownから多彩なフォーマットに出力できるスライド作成ツール MOONGIFT
最近、スライドをMarkdownで書く人が増えています。Markdownにしておくことでスライド形式はもちろん、HTMLで出力して後で公開するのも簡単になります。さらにそれを一歩進めてくれるのがMarkdown Slidesです。 Markdown SlidesはMarkdownで記述しますが、その後の変換先が多いのが特徴です。一つのフォーマットから多彩な変化をしてくれますので、とりあえずMarkdownで記述しておこうという気になるでしょう。 Markdown Slidesの使い方 サンプルです。スライドとして表示しています。 スライドの他、PDFでも生成できます。さらにODT/Docxでも出力可能です。 テーマは簡単に変更できます。 Reveal.jsを使った高機能なスライド。 PDF出力版。これはこれで便利ですよね。 こんな感じの一枚モノとしても出力できます。 目次もちゃんと動きます
GitBook·Markdownで書いて電子書籍/HTMLを生成 MOONGIFT
電子書籍を作るのは大変というイメージがあります。ePub自体は単なるZipファイルですが、その内容がXML/XHTMLなのが若干面倒さを感じさせます。専用のエディタもありますが、書き慣れたエディタの方が筆も進むというものです。 そんな訳で使ってみたいのがGitBookです。Markdownで書いて、ePub/PDFに変換するGit/GitHub連動型電子書籍作成ツールです。 GitBookの使い方 早速サンプルの電子書籍を見てみましょう。HTMLにも変換できます。 JavaScriptの勉強です。左側に目次、右側にコンテンツという形式になります。 ページ切り替えは矢印キーでもできます。ページの内容が1画面に収まっているのがいい感じです。 目次を隠すことが出来ます。 検索はインタラクティブにできます。 JavaScriptをWeb上で実行できます。今後、RubyやPythonにも対応させる予
GugoDoc - 複数ファイルをサポートしたMarkdown to HTMLジェネレータ
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 最近ドキュメントはMarkdownフォーマットで統一するようにしています。しかしドキュメントが大きくなるとメンテナンスコストが増大してしまいます。そこで分割するのですが、Markdownの基本機能だけではドキュメントを分割した場合にうまく対応できません。 そこで使ってみたいのがGugoDocです。複数のMarkdownファイルを結合、表示してくれるHTMLドキュメントジェネレータです。 使い方は簡単で、入力ファイルが入っているフォルダ、出力先のフォルダを指定するだけです。 $ ./gugodoc tmp tmp2 Build Site tmp to directory tmp2 Warning : output dir not found -> tmp2 created Info:
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
HTML を Markdown へ変換するときに知っておきたいライブラリ 11選 + α – プログラミング生放送
