markdownlintで設計書の品質を高める | フューチャー技術ブログ
はじめにフューチャー技術ブログのリレー形式の連載である、春の入門祭り2023の1日目です。TIG真野です。 ここ数年、Markdownで設計書をチームで書き、GitHub（GitLab）上でレビューするフローを採用しています。なるべくテキストベースで設計開発フローを統一するため、私の所属するチームでは以下のようなツールを採用しています。 シーケンス図、業務フロー図 Markdown中にPlantUMLで記載 参照はGitHub上からも見れるように、pegmatite を利用 システム構成図など画像系 Diagrams.net（draw.io）で作成し、.drawio.png の拡張子でMarkdownから参照 これだけは目視で差分チェックとなる Web API定義 OpenAPI SpecのYAMLファイル 参照はGitHub上からも見れるように、swagger-viewer を利用 ER
【roff形式を手書きは無理ゲー】manページをMarkdown + Pandocで作成【with manページお作法】
【roff形式を手書きは無理ゲー】manページをMarkdown + Pandocで作成【with manページお作法】 by nao · 公開済み 2020年12月19日 · 更新済み 2020年12月25日 前書き：manualページは伝統的なドキュメント manページは、UNIX系OSのドキュメントであり、コマンドやシステムコールなどの説明が記載されています。 Unix v7の時代（1979年）から変化が少ないため、2020年現在の視点で見ると表現力に難があります。具体的には以下のような欠点があり、manページを良質なドキュメントとするには文章力を試されます。 画像を挿入できない ハイパーリンク非対応 Terminalからしか参照できない（manページをHTMLに変換して公開しているサイトはあります） 勿論、manページより表現力が高いTexinfo、Docbookなどの代替ドキュメ
納品ドキュメントの作成にMarkdown+Vivliostyleを採用した話 - Qiita
こんにちは、製造業でソフト開発エンジニアをやっているとみー(@tommyecguitar)です。 会社で納品物の説明ドキュメントを作ることがあり、その時にMarkdownでの組版をやってみたので、どう運用したか、困ったところ、いい点、悪い点をまとめてみようと思います。 Vivliostyleで組版したブログはたくさんあるので、見た目がどんな感じにできるかなどはそちらを見ていただくか、Vivliostyleのサイトをご覧ください。 Wordじゃだめなのか。 製造業で何かしら長大なドキュメントを作るとなったら、大抵はWordを複数人数で編集するという運用をしているところが多いと思います。 しかし、Wordにはいろいろと悪いところがあります。 チーム内で共同編集すると、編集したところが消えたり、フォントやデザインがなぜか統一されなかったりする。 セクションごとに担当を分けても、マージが手作業にな
記事の書き方
writing.md 記事の書き方 記事の執筆には、Markdown形式を利用してください。 Markdownにはさまざまな流派がありますが、GitHub Flavored Markdown（https://github.github.com/gfm/ ）をベースとした書式を採用します。 書籍を執筆するための形式として考えると、Markdownには不足している機能が多々あります。 しかし、次のような利点があるので、Markdownを採用することにします。 最低限の構造しかないので、見た目でごまかせる余地が少ない 原稿を著者自身が再利用してもらいやすくしたい ラムダノートで販売する際のスタイルは、原稿の形式がなんであれ、別に考えなければならない 以下では、節や項といった記事の大構造、および、段落やコードや図表といった記事の小構造について、 執筆にあたって気を付けていただきたいことや記述方法の
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
Argdown
Simple Writing pros & cons in Argdown is as simple as writing a Twitter message. You don't have to learn anything new, except a few simple rules that will feel very natural. Expressive With these simple rules you will be able to define more complex relations between arguments or dive into the details of their logical premise-conclusion structures. Powerful Argdown can even be used within Markdown!
LaRecipe - Markdownから格好良いドキュメントを生成
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました 開発者に対して見栄えの良いドキュメントを提供する、これはDevRelにおいて大事な要素です。誰だって使いづらい、読みづらいドキュメントは嫌がるものです。デザインはもちろんのこと、文字サイズや見出しの付け方などによっても可読性は変わってきます。 そこで紹介したいのがLaRecipeです。Laravelを使い、Markdownから綺麗なドキュメントを生成してくれるソフトウェアです。 LaRecipeの使い方 デモです。左側に大見出し、中央がコンテンツ、右側にそのページのアウトラインが表示されます。 コードなども綺麗に表示されます。 アウトプットのデモデザインを入れている例。 ドキュメントの下にはコメント欄が用意されています。 左側の目次は非表示にできます。 検索も使えます。 LaRec
win10のEmacsでmarkdownを書く環境を整える - Qiita
概要 markdownを書くエディタとしてkobitoを使っていたけど、キーバインドが弱いのと、やたらエラーが多いのでやっぱりemacsで書くことにする。 要件 Emacs上でリアルタイムプレビューができること 出力されるプレビューは、githubのようなスタイルとする 自環境 Windows 10 GitBashをCmderで使用（GitBashの中身はmingw） Emacs 25 pandoc markdown-modeでは、プレビュー機能のためにmarkdown文書をhtml化するツールが必要。 インストールが楽なのでpandocを利用するものとする。 インストール pandocのwindows用インストーラーは https://github.com/jgm/pandoc/releases/latest からダウンロードできる。 デフォルトで c:/Users/<user>/App
MarkdownノートアプリInkdropで家賃の半分が賄えるようになりました
4月にInkdropの総売上が10万円を超えた報告をしてから、久々の売上報告です。Inkdropはクローズドソースですが、プロジェクトで得た知見は惜しみなくオープンにしていくつもりです。どんどんやり方パクってください。もし質問などあればコメント欄やTwitterにて受け付けます。 TL;DR驚きの解約率の低さ注文の多い少数派を相手にしすぎないブログを始めたら日本のユーザが増えた1000人のユーザが１人を食わせるモデルを確立したいInkdropはMarkdown好きのためのノートアプリ既にInkdropについてご存知の方は読み飛ばして下さい。 Inkdropはマルチプラットフォームで動作するノートアプリです。今のところmacOS、Windows、Ubuntu、iPhone、Androidに対応しています。 日々の作業記録や議事録、コードスニペットからブログの下書きまで、技術的な事柄を構文ハイ
Electron で Markdownプレゼン作成ツールを作って公開するまで - Qiita
Markdown でスライドを作るためのツールを漁っていたのですが、なかなか自分好みのものが無く、Electron の勉強を兼ねて作ってみた話です。 追記 (2018/12/10): その後の進捗はこちら Puppeteer & Carlo を Markdown スライド作成 CLI ツール (Marp CLI) で活用する - Qiita 成果物 今回作ったプレゼンツールは、以下にてプレリリース版を公開しています。 Marp - Markdown presentation writer https://yhatt.github.io/marp/ (旧称 mdSlide) 追記 (2016/07/13 19:42) ＿人人人人人人人人人人人人人人＿ ＞ 突然のGithubトレンド入り ＜ ￣Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y^Y￣ Markdown スライドツール比較表 私の欲
Markdown スライド作成ツール『Marp』の開発経緯裏話 - Speee DEVELOPER BLOG
2019/08/03 追記: 2019年現在、デスクトップアプリ版の Marp はすでに開発を中止しており、次世代版である Marp Next の開発に注力しています。デスクトップアプリはまだ使用可能ですが、すでにメンテナンスが中止されており、セキュリティに関する一部懸念も指摘されているため、デスクトップアプリ版をこれから使い始めるのは決して推奨されません。 移行先として、Marp Next の公式ツールの1つとして提供されている Visual Studio Code の拡張機能、Marp for VS Code をお勧めしています。クロスプラットフォーム・オフライン対応・ライブプレビュー・PDF出力はもちろん、新しい Marpit フレームワーク をベースとした Markdown 構文、HTML 形式や PowerPoint 形式での出力、カスタムテーマ CSS の対応など、スライド作成
Marp - Markdown Presentation Writer
It's a time to migrate into Marp Next! The publication of classic Marp app has ended. Marp desktop app, a simple Markdown presentation writer, already had stopped maintenance since 2017. Today Marp team is focusing into Marp Next project, the brand-new presentation ecosystem for the future. See more details in our blog post. Why? We had kept publishing app for stuck users that are thinking Marp Ne
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
Qiita の markdown を Emacs からプレビューする
(defun qiitadown () (interactive) (shell-command (format "qiitadown.sh %s" (buffer-file-name)))) (with-eval-after-load "markdown-mode" (define-key markdown-mode-map (kbd "C-c C-c C-q") 'qiitadown)) パスの通ったディレクトリに以下のシェルスクリプトをパーミッション 755 とかで置きます。 あと、qmc コマンドが必要です。Prepare に書いてあるように qiita-markdown-cli gem もインストールして下さい。 markdown ファイルを開いて、C-c C-c C-q すれば Chrome とかでプレビュー が見られます。
Big Sky :: markdown を何時でもチャラーっとプレビューしたい。
ちょっと書き物をする用事があって、markdown で書かなきゃいけなかったんですが 余計なインストールの手間が不要で 余計な設定は一切不要で 使い勝手は Linux や Windows 全て同じで 出来れば Markdown 保存したら自動更新されて GitHub Flavour Markdown でコードハイライトト GitHub Flavour Markdown でテーブル表記 こういうのが欲しくて、あるアプリケーションを見つけたんだけど外部の JavaScript を使ってる上にそのリソースURLが無くなり動かなくなってて困ったので作った。 今後もこういう事あるだろうし、自分用に作っておくべきだと思った。書き物をする予定だったのに気付いたら作ってたのでしょうがない。僕のせいではない。 mattn/mkup - GitHub README.md mkup Portable Markd
Markdownからスライド資料を作る
B! 460 0 1 0 何か人に見せる時には資料としてPower Pointとかでスライドを作るわけですが、 普段メモもMarkdown形式で書いてく事が多くて、 簡単なもの、特に文字だけの物の場合はそのままコピペするだけみたいな ことも多いので、 直接Markdownからスライドを作る物を試してみることに。 Markdownからスライドを作れるツール Pandoc 対応フォーマット インストール PDF作成(beamerテンプレートを使う) beamerのテーマについて 日本語について Pandocまとめ Slide Show (S9) インストール スライド用HTML作成 PDFにコンバート その他のツール Marp mkd2pdf markdown-pdf markdown2impress mdslide slidedeck remark Markdown2pdf Swipe Sl
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
脱ExcelしたいMarkdownテンプレート目次 - Qiita
gmork.in
公式チュートリアルから始めるVue.js vol.1「Markdown エディタ」
Amazon.co.jp: ドキュメント作成システム構築ガイド[GitHub、RedPen、Asciidoctor、CIによる モダンライティング]: 伊藤敬彦 (著), 吉村孝広 (著), 208 (その他): 本![Amazon.co.jp: ドキュメント作成システム構築ガイド[GitHub、RedPen、Asciidoctor、CIによる モダンライティング]: 伊藤敬彦 (著), 吉村孝広 (著), 208 (その他): 本](https://cdn-ak-scissors.b.st-hatena.com/image/square/b3e159842a1f96e7a6cd3ad60234c73b55fc521d/height=288;version=1;width=512/https%3A%2F%2Fm.media-amazon.com%2Fimages%2FI%2F516v0w26krL._SL500_.jpg)
