GitHubで講義ノートを書く
はじめに 大学の講義ノートをいくつかGitHubで公開しています。 講義ノートをMarkdownで書いてGitHubで公開、というのをしばらく続けて、いろいろノウハウが溜まったので共有してみようと思います。 大学の講義ノートをどうするか問題 昔から大学の講義ノートを公開する人は結構多いです。最初期は、LaTeXで書いてPDFで公開することが多かったように思います。これはこれで良いのですが、基本的にはダウンロードして印刷して読む前提であり、ウェブで気軽に読める形ではありませんでした。その後、LaTeX2HTMLを使って、LaTeXファイルをHTMLに変換して公開するケースが増えました。これによりウェブで講義ノートが気軽に閲覧できるようになったのですが、いかにも「LaTeX2HTMLを使って変換しました」という外観になるのと、(少なくともデフォルトでは)レスポンシブではなく、スマホ非対応になる
Markdownでシーケンス図とかが書けるMermaid記法で業務フローを書いたら意外とイケたので自分なりのコツを紹介してみる | DevelopersIO
こんにちは、臼田です。 みなさん、業務設計してますか？(挨拶 今回はMarkdownでシーケンス図やフローチャートなどの図を記述できるMermaidを使って業務フローを書いてみたら、意外と書けたので自分なりのTipsを紹介したいと思います。 その前に 注意点として、まだMermaidを使い始めたばかりなので、「もっとこうしたらいいぞ」とか「こっちのほうがいいぞ」とかあれば建設的なフィードバックとしてSNSとかでいただけるとありがたいです。 あと業務フローって表現しましたが、人によって思い描く業務フローが違うと思うので、業務フローの定義に関するツッコミはご容赦ください。私が今回Mermaidで書いたのは以下の図です。(内容はブログ用に簡素化しました) この図のコードは以下のとおりです。(後ほど解説します) sequenceDiagram autonumber actor お客様 partic
結局UMLとかシーケンス図とかAWSの図とかどれで描くと良いのよ？と思ったときの選択肢 - Qiita
自身のプライオリティによりますが、いくつか。 Markdownで幅広く再利用性を利かせたい、長期的に丁寧に版管理したい 自分自身の操作性、描きやすさと、見た目 俄然手軽に、短期的に、Onlineでいつでもどこでも いずれかという視点で考えると良いのかなと思い、並べてみました。 1. 長期的に: Markdownで幅広く再利用性を利かせたい、丁寧に版管理したいなら Markdownで描くことのメリットは再利用性。 将来的に追記・編集、自分以外の誰かが手を入れる可能性が高い。 現在のドキュメントだけでなく多種説明資料、媒体に転用する可能性がある。 ...という点で差分管理をしたいなら、以下。 VSCodeでPlantUML、Mermaid 上記参考で以下。 Alt+D でプレビュー起動。 Ctrl + Shift + P でコマンドパレットを起動し、出力。 png, svg, eps, pdf
VSCodeは理系にとって最高なノート - blog.tamaosa.com
この記事はQiita の記事を加筆修正したものです。 はじめに最近 Visual Studio Code で Markdown 環境を作ったのですが、markdown-preview-enhancedが思いのほか何でもできて、とくに理系のノートとして良さげに感じたのでメモします。 すでに良記事（こちらやこちらとか）がたくさん挙げられているので参考にしてください。 ノートに求めるものノートに求める要素を自分の経験を元に独断と偏見で挙げると、 数式が手軽に書ける図が手軽に書ける表が手軽に書けるグラフが手軽に書けるてな感じかと思います。とにかく手軽にサクッと書きたいですよね。 Visual Studio Code + markdown-preview-enhanced はこれらすべてを叶えてくれます。 markdown-preview-enhancedmarkdown-preview-enhan
MarkdownをPDFに変換する「md-to-pdf」は痒いところに手が届く素敵ツール | DevelopersIO
Markdown to PDF Markdownで書きたいけど、PDFで出力したい という機会はエンジニアはよく出くわすと思います。 「Markdown to PDF」といえばGitBook CLIが有名ですが、こちらはメンテナンスがストップされているため推奨されません（環境依存による不具合などが解決されない）。 GitBookほど多機能でなくても良いですが、綺麗にいい感じに出力したい…！と探し回っていたところ md-to-pdf が最も私の要件に合致したので使ってみました。 そんな私の要件はこちら。 CLIから出力したい ページ内リンクが作れる ページ分割ができる ページ数表示が簡単にできる 全体に対して簡単にテーマをCSSで適用できる いざという時にはHTML+CSSでカスタマイズができる それに対して md-to-pdf は以下のような機能があります。 ディレクトリ内のMarkdow
Markdownで書いた実験レポートをTeX組版の美しいPDFに変換するDockerイメージを作った - ぷらすのブログ
特徴Markdown を PDF に変換する方法STEP1 : Docker イメージを pull するSTEP2 : 変換したい Markdown ファイルがあるディレクトリに移動するSTEP3 : PDF に変換する発展的な使い方保存するたびに PDF に変換するalias を使って簡単に変換を実行できるようにするMarkdown ファイルを tex ファイルに変換するpandoc を使った変換終わりに参考こんにちは、@p1assです。 皆さんは、実験レポートを何で書いていますか？ Word ですか？それとも LaTeX ですか？ 私はそのどちらでもなく、 Markdown 書いています。 Markdown はシンプルなシンタックスで様々な表現ができ、多くのエンジニアに愛されています。 しかし、Markdown は実験レポート用途にあまり使われていないため、そのままでは美しい PDF
【ドキュメントが書きたくなる】Markdownライブプレビュー + インライン数式/UML/図表 + 綺麗にPDF/Wordエクスポートまで - Qiita
【ドキュメントが書きたくなる】Markdownライブプレビュー + インライン数式/UML/図表 + 綺麗にPDF/WordエクスポートまでPandocATOMumlPlantUML これはなに インライン数式、UML、図表をライブプレビューしながらMarkdown+αで記述でき、PDF/Word/HTMLなどへのエクスポート機能をもつAtomプラグインmarkdown-preview-enhancedを紹介します。 これを使うと、ドキュメント作成が捗ること間違いなし。 Github上では、Packageは2016年3月に開発スタートし、継続して成長しています。 (16.9.23追記) 図表を含めたexportは、pdf, html exportでは使えるが、pandoc では未対応(Issue #138, pandoc export機能詳細)。word形式を使いたい時に課題あり。取り込み
Markdownで書ける、よさげなWikiサーバーソフトまとめ - Qiita
※この記事は僕のブログ（最近始めました）のクローン記事です。 なんとなく、グループ内部用のWikiに最適なやつって無いのかなあと思ったのです。特にどのグループというわけじゃありませんが、ええ、なんとなく。 サーバー設置型のWikiソフトウェアというと国内で有名なのはPukiWikiでしょうか。設置も手軽で拡張性も高く、すでに慣れ親しんだWikiですが、最近では各方面がMarkdownを採用してそれに慣れ親しんでしまい、このブログもプラグインを入れてMarkdownで書いているぐらいなので、Markdownで書けるWikiを探していたのです。 必要要件はこんな感じ。 サーバー設置型 グループ内部向けのポータル的Wikiに適している Markdownで書ける 使い方が簡単 日本人に厳しくない デザインがナウい というわけで昨日から丸２日ぐらいぶっ通しで調べぬいた結果はっぴょー。どんどんぱふぱふ
RedmineのコンテンツをMarkdownに変換しました - yuumi3のお仕事日記
Textile vs Markdown 軽量マークアップ言語にはたくさんの種類があります。私も教育で使うテキストの作成やRedmineのWikiでは長年 Textile を使って来ました。 しかし、最近はGithubの標準のマークアップ言語がMarkdownだったり、Atom(エディター)をはじめたくさんのMarkdownをサポートするツールが現れ、私も MacDownというツールが気に入り開発ドキュメント等のMarkdown化がどんんどん進んでいます。このブログもはてな記法ではなくMarkdownを使っています。 TextileとMarkdownを比べると 標準のMarkdown は記述能力が低くテキストを作るには能力不足ですが、 GitHubの拡張 や php Markdown Extra などの拡張機能を使えば、ほぼ同等です。 Redmine Redmineのマークアップ言語のデフォ
快適 Markdown ライフを送ろう！Mac で使える Markdown 支援ツール6選 | DevelopersIO
Markdown 形式のドキュメントを快適に書こう ちょっとしたメモから Wiki のような文書まで、幅広く利用されている Markdown。私も簡単なメモなどや外部メディア記事の原稿の執筆などに利用しています。 適当なテキストエディタで適当に書くだけでも良いのですが、Mac で Markdown 形式のドキュメントを書く上で便利そうなツール (プラグイン) がいくつかあったので、個人的なまとめを公開したいと思います。 Sublime Text 3 + 各種プラグイン Markdown 形式のドキュメントの作成には、主に Sublime Text 3 を使っています。Sublime Text は言わずと知れた有名テキストエディタで、今やテキストエディタの代表格にまで上り詰めました。バージョン2で一躍有名となり、現在はバージョン3が主流になっています。 Package Control のイン
Markdownテキストでシーケンス図とフローチャートを描く - Qiita diagram sequence
つい先日、とあるシステムの処理の流れと一部処理のフローチャートを付けた見積り資料を書くことになり、ちょうど良い機会だったので、MarkdownでUML図表が描ける「StackEdit」を使って、オールMarkdownで資料を作成してみた。 いやぁ、打ち込んだテキストがリアルタイムに図表化されていく様は、とても新鮮で、そしてすごく面白かった。資料が出来上がった後の達成感というか、完成した図表を見た時の感動が結構はんぱない。技術系の資料作成でこんな良い体験ができたのは初めてかもしれんな…(笑) ──と、結構感動的な体験ができるMarkdownでのUML図表作成なんだが、せっかくなのでそれの書き方を含めてもう少し突っ込んだTIPSとしてまとめておこうかと思った次第。 Markdown+UML とは？ とりあえず、「Markdown+UML」というのは私の造語だ。まぁ、正確に言うなら「UML di
脱GitHub初心者を目指す人のREADMEマークダウン使いこなし術 | ゆっくりと…
README がキチッと書かれているプロジェクトって、どんなに小さくても立派に見えますよネ。 GitHub の場合、大抵はマークダウン記法で書かれた README.md とか README.markdown とかいう名前のファイルが、HTML に変換 （マークアップ） されて表示されていることはご存知でしょう。 マークダウン記法自体はとても簡単なのですが、GitHub では GitHub Flavored Markdown （略して GFM） という GitHub 用にアレンジされたマークダウン・エンジンが採用されていて、一般のマークダウン・エディタでチェックしてからコミットしても、意図通りの見た目にならないことが多々あります。私 （もちろん GitHub 初心者です！） の場合、README ファイルだけで10回以上もコミットしてしまいました。「マークアップ （レンダリング） を気にして
HTML変換やプレビュー可能なTextMateはMarkdown用テキストエディタとしても優秀
MBAのテキストエディタとしてTextMateを使っているのですが、このエディタはMarkdownを書くときに便利な機能があるので結構重宝しています。私は使いこなせていないですが、ちゃんと使えばいいエディタなのでしょう。 TextMateはbundleというものを追加でき、Markdownのbundleもあります。 Markdownのbundleをインストールすると、MarkdownからHTMLへの変換も可能です。でも、エクスポートするわけではなく、変換元のファイルが書き換わるみたいなので、別名で保存して元に戻すとかする必要があるみたいです（エクスポートできるのかな？）。 また、Markdownをプレビュー画面で確認することも可能です。エディタ自体の文字が大きくなったりしてくれるのでそれだけで便利ですが、ワンコマンドでエディタ下のビューにプレビューを表示することもできるので結構便利。 Ma
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - lukakerr/Pine: A modern, native macOS markdown editor