Markdown で技術書が書ける｜abechanta
ソフトウェアに関する記事やコラムを書くなら、Markdown 記法はとても良い選択です。見た目の統一感があり、覚えやすく、軽量です。 この「Markdown での書きやすさ」を物理書籍や電子書籍の執筆にも応用できたらな、、、 "W3C Paged Media Viewer" はそれを実現する、OSS の Visual Studio Code のエクステンションです。エクステンションを入れただけの超シンプルな環境を使って、手間いらずでサクッと技術書を執筆することができます。 以下に示すとおり導入は簡単です。 1. VS Code を起動します 2. CTRL + SHIFT + X とタイプして Extensions ビューを表⽰します 3. 検索ボックスに paged media と⼊⼒し、 W3C Paged Media Viewer あるいは abechanta.vscode-ext-
新しいマークダウンパーサーが必要な理由 | NHN Cloud Meetup
最近の開発者が最も好むドキュメント形式を挙げるとしたら断然マークダウンになるでしょう。マークダウンは、GitHub、GitLab、Bitbucketなど、タスクやイシュー管理に対応するほとんどのサービスにおいて、基本のドキュメント形式として使用されています。また、IntelliJ、VSCode、Vim、Emacsなど、ほぼすべてのテキスト編集ツールでも、プラグインを通じてマークダウン文書の強調構文やプレビュー機能を使用することができます。 TOAST UI Editorはここからさらに一歩進んで、マークダウンエディターとウィジウィグエディターを統合した形式のインターフェースを提供しています。ウィジウィグエディターを使用すると、テーブルなどの複雑な文法をより直感的に簡単に編集することができ、マークダウンに慣れていないユーザーでもマークダウン基盤の文書を簡単に編集できます。特に、開発者と非開発
TODO.md Kanban Board - Visual Studio Marketplace
Todo Kanban Board Todo Kanban Board manages tasks and save them as TODO.md - a simple plain text file. Features The syntax is compatible with Github Markdown TODO.md file is portable and can be committed with Pull Requests (PRs) to git repositories. Support custom file name, multiple task lists. Checkboxes are optional (if your task titles don't have them). Task title can also have markdown for st
GitHub Flavored Markdown は何であって何でないか - Qiita
のんびりしていたらこんなメンションをもらっていたので、ちょっとまとめてみようと思います。 そろそろ @tk0miya さんがアップしてくる頃。GFMはspecかっちりしてるんでしたっけ(markdown全く詳しくない — Aki Ariga (@chezou) February 1, 2020 かっちりしている? この記事を読んでいる皆さんは Markdown の歴史に精通していると思うので、古い部分はざっくり割愛してしまいますが、オリジナルの Markdown は かっちりしていない ことで有名なマークアップ言語です。 必要最低限のマークアップ要素は規定されていて HTML への変換ツールも完成していた Markdown ですが、マークアップ言語の言語仕様としては貧弱で、インデントのルールやインライン要素をネストしたときの挙動、空行の有無による解釈の違い、などなど、細かい部分のルールにつ
まだ Word で消耗してるの？ 大学のレポートを Markdown で書こう - Qiita
環境構築が Docker でスッと行えるようにした新版を公開しました まだまだ Word で消耗してるの？ 大学のレポートを Markdown で書こう （Docker 編） https://qiita.com/Kumassy/items/ffa752da5f7193c4929c みなさん、大学の実験レポートは何で書いていますか？ Word ですか？ 私も去年は Word で書いていたのですが、特に数式の入力や式番号を振るのに苦労した覚えがあります 今年は LaTeX で書いてやる！ と心に決めていたのですが、LaTeX のシンタックスはちょっと面倒くさい感じがしました... そこでみつけた Pandoc Pandoc について Pandoc は Haskell で書かれた文章変換ツールです。Markdown から LaTeX、PDF の変換もできますし、ほかにもたくさんのフォーマットに対
MarkDown記法と、QiitaとVSCodeの違い - Qiita
はじめに MarkDownを様々な場所で書くことが増えてきました。 私の場合は、VSCodeでもMarkDownを書いて、プレビューで見たりしますが、 Qiita、VSCodeでは若干表示に違いが(というか一方では思った通り表示されない)ことが時々あるため、チートシートついでにQiita、VSCodeでの違いをまとめました。 ※VSCodeでのMarkDown表現は初期の状態です。 見出し 先頭に#(半角スペース)をつけ、見出しを書きます。 ##と重ねていくと見出し2、見出し3...となっていきます。 別の書き方として、文字列の下に=をつけると見出し1に、文字列の下に-をつけると見出し2となります。(=、-の個数は自由)
gitbookで楽々ドキュメント作成 | Tech Blog | CRESCO Tech Blog
ご無沙汰しております。技研の（ほ）です。 突然ですが、仕様書などの各種ドキュメントを作る際には、みなさんは何を使っていますか？ Sphinxのエディタ選択の際にも同じことを書いたのですが、私は今でもSphinxがベストだと思っています。
SphinxをMarkdownで使い隊
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
OSSドキュメント翻訳を支える技術 (Keycloakを題材に) - Qiita
Keycloakドキュメントの翻訳ではどうしているかというと、3つ目のテキスト抽出した部分のみを翻訳の方式を採用しています。というのも、現状、毎月のように最新版がリリースされており、ドキュメントもどんどん変わっていく恐れがあると思い、変更に追随しやすい(はず)、翻訳者は翻訳作業だけに集中できる、という点から3つ目の方式を今のところは採用しています。 ソーステキストからのテキスト抽出について 方式3を取る場合、テキスト抽出を行い、翻訳後に元のテキストにマージする仕組みが重要になってきます。というわけで、次はテキスト抽出について述べます。 翻訳対象のソーステキストフォーマット テキスト抽出を行うためには翻訳対象のソーステキストフォーマットが重要なポイントになってきます。OSSドキュメントで利用される代表的なテキストベースのドキュメント作成ツール/マークアップ言語としては以下があります。 Asc
mermaid.jsが素晴らしいけどなかなか使ってる人見かけないので実例晒す(追記あり) - Qiita
mermaid.jsとは JavaScriptのチャート作成ライブラリです。他にも似たようなのは色々ありますが、これ一本でフローチャート、シーケンス、ガントに対応してるので、個人的にお気に入り。 http://knsv.github.io/mermaid/ サイトの各チャートのページ見ると書き方と何ができるかはわかるので、ご覧あれ。 僕の使い方 JSのライブラリを自分でインポートして何かすることはほとんど無くて(後述の理由からガントだけJSで使ってるけど)、基本的には以下の2つの方法で使ってる。 Haroopad フリーでクロスプラットフォーム(OS X, Win, Linux)なMarkdownエディタ。 v0.13からmermaid.jsがインテグされているので、何もしなくてもそのまま使える。 mermaid.jsのグラフの書き方は、コード表記で、言語をmermaidにしてあげるだけ。
MarkdownでSlide作成して自分のGitHub Pagesで公開する - 山ｐの楽しいお勉強生活
MarkdownでSlide作成して自分のGitHub Pagesで公開する奴を作りました。 資料がアチラコチラに散らばることがなく、テキストでGitなので差分が見れたりと結構便利です。 動きがあるスライドなどは辛いですが、さくっと作る時には良いかと思いますので良かったら使ってみてください。 忙しい人用まとめ SlideをMarkdownで書いて自分のGitHubで管理して、自分のGitHub Pagesで表示できるようにした。 reveal.js version 3.5.0を使用 毎回HTMLとか書きたくないので、Markdownのパスを指定すればスライドが表示されるようにした。 真似したい人は、リポジトリをForkやCloneして、GitHub Pagesで公開すればすぐ使えます。（↓に使い方書いてます） https://github.com/yamap55/SlideWithGitH
技術ドキュメンテーションのためのreStructuredTextとMarkdownを比較する | POSTD
Markdown と reStructuredText はどちらもマークアップ言語で、どのテキストエディタを使っても簡単に入力できるように設計されたプレーンテキスト形式構文です。どちらにもマークアップされたテキストをHTMLやPDFなどの出版形式に変換できるツールが多数あります。 これらのマークアップ言語は多くのドキュメンテーションシステムの基礎となるため、昨今のソフトウェア開発者はマークアップ言語をよく知っておく必要があります。この記事ではプログラマ視点でMarkdownとreStructuredTextのトレードオフを分析します。 Markdownが輝きを放つ場所 テキスト入力による豊富な書式設定で複雑なドキュメント構造を記述することができるマークアップ言語は長く輝かしい歴史を持っており、その歴史は少なくとも1970年代初めの troff とTeXまで遡ることができます。 これらの形式
Markdown Night 2017 Summer という勉強会が開かれました | メルカリエンジニアリング
connpass.com @magnolia_k_さん主催による、Markdown Night 2017 Summer という勉強会が開かれ、今回メルカリはその第1回目の会場提供をさせていただきました 1。 イベントページ公開後から結構な反響を頂いており、期待をしていたのですが、実際に開催してみても Markdown に対する熱い思いを持った方たちが集まり、それぞれの思いをトークにして盛り上がりました。なお、今回は esa や Kibela、Qiita といった各種 Markdown を使ったサービスを作っている知見を持った方たちの参加もあり、とても大盛況でした。 当日の様子は Twitter ハッシュタグから追うことができます → #markdownnight では、以下タイムテーブルとその発表です。 Markdownはなぜ拡張され続けるのか @__gfx__ さん blog.bitjo
GitHubだけで超高機能なスライド資料が作れる「GitPitch」の使い方を徹底解説！ -
どうも、まさとらん（@0310lan）です！ 今回は、ブラウザ上のGitHubでMarkdown（マークダウン）ファイルを作成し、そのまま超高機能なスライド資料に変換してくれるサービスのご紹介です！ もちろん、自分でMarkdownファイルを用意してpushするだけでもOKなのですが、今回はコンソール画面などは使わずにすべてブラウザだけで完結できる方法をご紹介致します。 【 GitPitch 】 ■「GitPitch」の基本的な使い方！ それでは、実際に簡単なスライド資料を作ってみましょう！ まず最初に、自分のGitHubアカウントでログインし、新規のリポジトリを作成しましょう！ 「① リポジトリ名」は好きな名前を付けてください。 画面下にある「② チェックボックス」をONにしてから「③ Create repository」ボタンをクリックしましょう。 すると、自動的に「README.md
[PHP+JS]マークダウン形式のシンプルなメモ帳サイトを作ってみた！ - Qiita
追記： 現在はVueでリニューアルされています。 Gmailの下書きをメモ帳代わりに使うのにも限界を感じてきた。 しかし、リッチテキストが嫌いなのでEvernoteを使う気にもなれず。。 というかマークダウンでメモをとりたい。画像貼れたりとかリッチな機能も全然いらない。ネイティブアプリ版もいらない。 というわけで、そんなサイトいくらでもあるだろうとは察しつつ自作してみました。 完全に自分で使うために作ったものの、せっかくなのでリリースできる形にしています。 『CosMoNOTE』 ゲストアカウントがあるのでお試し下さい。 まあ、個人の作ったサイトにメモを保存したがる人はあまりいないと思いますが、一応メモの内容だとかはちゃんと暗号化した上で保持されますし、僕が復元することもありませんのでご安心下さい。 使用技術 PHP+MySQL+JS(jQuery)を使いました。 ログイン後のメモ画面はペ
![[PHP+JS]マークダウン形式のシンプルなメモ帳サイトを作ってみた！ - Qiita](https://cdn-ak-scissors.b.st-hatena.com/image/square/30e673ea8d15b6b82936ae6ccb9c295d5130e750/backend=imagemagick;height=288;version=1;width=512/https%3A%2F%2Fqiita-user-contents.imgix.net%2Fhttps%253A%252F%252Fcdn.qiita.com%252Fassets%252Fpublic%252Farticle-ogp-background-412672c5f0600ab9a64263b751f1bc81.png%3Fixlib%3Drb-4.0.0%26w%3D1200%26mark64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZ3PTk3MiZoPTM3OCZ0eHQ9JTVCUEhQJTJCSlMlNUQlRTMlODMlOUUlRTMlODMlQkMlRTMlODIlQUYlRTMlODMlODAlRTMlODIlQTYlRTMlODMlQjMlRTUlQkQlQTIlRTUlQkMlOEYlRTMlODElQUUlRTMlODIlQjclRTMlODMlQjMlRTMlODMlOTclRTMlODMlQUIlRTMlODElQUElRTMlODMlQTElRTMlODMlQTIlRTUlQjglQjMlRTMlODIlQjUlRTMlODIlQTQlRTMlODMlODglRTMlODIlOTIlRTQlQkQlOUMlRTMlODElQTMlRTMlODElQTYlRTMlODElQkYlRTMlODElOUYlRUYlQkMlODEmdHh0LWFsaWduPWxlZnQlMkN0b3AmdHh0LWNvbG9yPSUyMzIxMjEyMSZ0eHQtZm9udD1IaXJhZ2lubyUyMFNhbnMlMjBXNiZ0eHQtc2l6ZT01NiZzPTE4MDFlNzdiYmFlMzE1MzMzODg0MmY5MDM1NTM1ZTZi%26mark-x%3D142%26mark-y%3D57%26blend64%3DaHR0cHM6Ly9xaWl0YS11c2VyLWNvbnRlbnRzLmltZ2l4Lm5ldC9-dGV4dD9peGxpYj1yYi00LjAuMCZoPTc2Jnc9NzcwJnR4dD0lNDBsYWluZXVzJnR4dC1jb2xvcj0lMjMyMTIxMjEmdHh0LWZvbnQ9SGlyYWdpbm8lMjBTYW5zJTIwVzYmdHh0LXNpemU9MzYmdHh0LWFsaWduPWxlZnQlMkN0b3Amcz00Yjg0NmY3NTA2YzY1ZWQ4ZGM0ZDU1YjQzODg3ZTZkMg%26blend-x%3D142%26blend-y%3D436%26blend-mode%3Dnormal%26txt64%3DaW4g5qCq5byP5Lya56S-44Oq44Oz44Kv44OQ44Or%26txt-width%3D770%26txt-clip%3Dend%252Cellipsis%26txt-color%3D%2523212121%26txt-font%3DHiragino%2520Sans%2520W6%26txt-size%3D36%26txt-x%3D156%26txt-y%3D536%26s%3Dfacb31a62eb0e2af03056d18995fc993)
100種類の言語に対応したプログラマー向けノートアプリ「Boostnote」 | ライフハッカー・ジャパン
「Boostnote」は100種類の言語に対応したプログラマー向けノートアプリです。Markdown形式のファイルも扱えますし、HTMLやJavaなど様々な言語に対応されています。シンタックスハイライトが有効なのでソースコードも見やすいですよ。また、よく使うスニペットを登録しておくと、すぐさま呼び出してコピーすることができます。起動時間も早くオールマイティに使えるノートアプリとなっていますよ。 以下に使ってみた様子を載せておきます。まずBoostnoteへアクセスしましょう。Windows, Mac, Linuxすべてに対応されています。 トピックごとにファイルをまとめて管理できますよ。編集画面の下部でノートのサイズやシンタックスハイライトの変更が行なえますよ。 また、Markdown形式で記述すると、その場でプレビューを表示させることができます。これは便利ですね。 MacだとComman
MarkdownをPDFに変換するnode.jsライブラリ「markdown-pdf」
2016年 7月1日 16時55分 7年前 node.jsでmarkdownからPDFに変換するライブラリ「markdown-pdf」の紹介です。 Markdownでドキュメントを書くのはスイスイ書けて Webページではパース出来ますが、問題は作成したドキュメントファイルを配布する時じゃないでしょうか。 " Markdownで作成したドキュメントをそのままエンドユーザーに送る "と考えると、難しい部分があり 配布先にプレビュー出来る環境を用意してもらう必要がでてきます。 そのような手間を省いてもらう為に、" markdown-pdf "を使って、MarkdownからPDFに変換しましょう! markdown-pdfはnode.js用のライブラリなので、npmコマンドを使ってインストールします。 # markdown-pdfのインストールコマンド npm install markdown-p
Gitlab CIを使ってSphinxのドキュメントを自動でPDFにビルドする - once upon a time,
gitlab.comは自前でDocker image登録できたり、CI持っていたりと便利ですね。しかも、privateレポジトリもお金かからないという太っ腹。 技術書典2に向けたレポジトリはgitlab.comで管理しています。 今回は共著者にPython使いが多いためSphinxを使って書いているんですが、Sphinxはcommon markでも書けるのでmarkdownでも文章を書くことが出来ます。 前回の記事では、数式入りのmarkdownからPDFを生成するDocker imageを作りましたが、それを使うと簡単にGitlab-CIでPDFが生成できます。 chezou.hatenablog.com やり方は簡単、あなたのSphinxのプロジェクトに、以下のような.gitlab-ci.ymlを書くだけ。もちろん、必要に応じてpathsは変更してください。 image: chezou
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Dendron
ローカル画像生成サーバ作ってMarkdown記事執筆を加速する - Qiita
