documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新
documentationjs + add-text-to-markdownでREADME.mdのAPIリファレンスを自動更新 documentationjsはJSDocからドキュメントを生成できるツールで、ES2015以降のコードにも対応しています。 (TypeScriptは対応してないようです) 以前はMarkdownへの出力が難しかったのですが、いつのまにかdocumentation build -f mdでMarkdownでのAPIドキュメントが生成できるようになっていました。 これを使うことで、ライブラリを書いてそのJSDocからドキュメントを生成して、READMEのUsageセキュクションを自動的に更新できるようになっています。 以前もできたのですが、かなりトリッキーなテーマを書いたりしないといけませんでした。(後stdoutへの出力がなかった気がします) –theme for
Docz
Powered by GatsbyStarting from v2, Docz is entirely built using GatsbyJS. It's optimised for a lightning fast development experience and speedy build times. This also allows you to leverage GatsbyJS's huge ecosystem of plugins and tools. Zero configNo need to worry about complex configuration settings to build and run your documentation. With Docz you can create customizable sites with a single co
最強のMarkdown編集環境としてのAtom - たけぞう瀕死ブログ
ブログなどちょっとした文章の編集から書籍の執筆までMarkdownを活用しています。これまで試した各種テキストエディタのMarkdown編集支援機能や、Markdown編集専用のツールはどれも満足の行くものではなかったのですが、最近はAtomに以下のようなパッケージを入れた環境が理想に近いMarkdown編集環境を得ることができました。 少し前にエンジニアHubさんで各社のエンジニアの方がオススメのAtomパッケージを紹介するという企画記事があり、私もMarkdown関連のパッケージを紹介させていただいたのですが、この記事では各パッケージを簡単にしか紹介できなかったので、ここでは少し詳しく紹介したいと思います。 employment.en-japan.com document-outline atom.io サイドバーにMarkdownの見出しをツリー状に表示してくれるパッケージです。書籍
AlminのサイトをOSSドキュメントツールのdocusaurusで作り直した
Alminでは元々GitBookを使ったドキュメントサイトをhttps://almin.js.org/で公開していました。 最近、OSS向けのドキュメントサイト作成ツールであるDocusaurusが公開されたのを受けて、GitBookからDocusaurusに移行しました。 Alminのサイト: Almin · Flux/CQRS patterns for JavaScript application. https://github.com/almin/almin DocusaurusはEasy to Maintain Open Source Documentation WebsitesとあるようにOSSのライブラリやプロダクト向けのドキュメントサイトを作る一種の静的サイトジェネレーターです。 Facebookから公開されていることからも分かるように、JestやPrettier(Faceb
gitbookで設計書を作成したら最高だった話 - フォトシンス エンジニアブログ
こんにちは。Akerunエンジニアの @ishturk です。 Akerun Advent Calendarの記事です。 今日は設計書の話です。 設計書をどんなツールで書くかは、僕らソフトウェアエンジニアの尽きない悩み（楽しみ）ですね。 最近はまったツールが最高に良かったので紹介させてください。 僕のツールに求める要件は以下です。 編集がカジュアルにできる UMLが書ける。あとから編集できる（画像での貼付けは編集できないのでNG） バージョンの管理ができる 好きになれる（重要） 変遷と pros/cons MS Word pros 良くも悪くもスタンダードなツールですね。 だれでも編集できるのが強みです。 Visioと組み合わせれば、UMLも後から編集可能です cons Visioは標準にするには少々値が張ります。 バイナリ形式なのでバージョン管理はしづらいです。 ページが増えたり画像を貼
Typora — a markdown editor, markdown reader.
Readable & WritableTypora gives you a seamless experience as both a reader and a writer. It removes the preview window, mode switcher, syntax symbols of markdown source code, and all other unnecessary distractions. Instead, it provides a real live preview feature to help you concentrate on the content itself. Distractions Free Seamless Live Preview What You See Is What You Mean
Sphinx から完全に reStructuredText を追い出した話 - Hack like a rolling stone
いくつかの記事で紹介されているとおり、 recommonmark を使うと Sphinx で markdown を使うことができます。 Software Design 2016年4月号 Markdownで始めるSphinx MarkdownでSphinxできるようになったので試してみた（前編） - 意識の高いLISPマシン Markdownで書けるSphinxの構築 - Qiita しかし、recommonmark を利用しても、ドキュメント構造(toctree)を記述するためには部分的に reStructredText を使う必要がありました。 .. toctree chapter1 chapter2 chapter3 これは、文法を拡張する仕組みを持たない markdown の (commonmark の)構造上、仕方がないのですが、せっかく markdown でドキュメントを書いてい
GitHub Flavored Markdown をもっと Vim でハイライトする vim-gfm-syntax つくった - はやくプログラムになりたい
Vim にはデフォルトで Markdown のドキュメントをハイライトするためのファイルが同梱されています．基本的にはこれで満足なのですが，僕が書くのはほぼ GitHub Flavored Markdown（GFM: GitHub で使える拡張された Markdown 記法）なので，一部ハイライトされない構文があります． そこで，既存のハイライトに GFM 向けのハイライトを追加する vim-gfm-syntax という Vim プラグインをつくりました．インストールは一般的な他のプラグインと同じです．ハイライトを追加するだけなので，設定済みの markdown ファイルタイプの設定を壊すことは無いはずです． github.com 入れる前 入れた後 このプラグインを入れると，デフォルトで markdown ファイルタイプのファイルを読んだ時に次のハイライトが追加されます． テーブル記法
Markdown風テキストでダイアグラムが描けるWebツール - Qiita
MarkDownDiagram Markdown風のテキストで、ER図やブロックダイアグラムのようなチャートを描けるツールです。 こちらにインスパイアされて、もうちょっと汎用的にダイアグラムを描けるツールを作りました。 もう保守されない画面遷移図は嫌なので、UI Flow図を簡単にマークダウンぽく書くエディタ作った 特徴としては Webブラウザのみでローカルで動作 配置はマウスでドラッグして編集できる CSSで色や装飾を制御可能 といったあたりです。 githubからclone/ダウンロードして使えます。 オンラインで試すのはこちらでどうぞ。 ローカルでブラウザのみで動作します。index.htmlをブラウザで開いてください。 Chrome推奨ですが、Safari,Firefoxでも動作します。タッチIFは未対応。 機能 テキストでブロックを記述し、ブロック間を線で繋ぐ描画 ブロックをマウ
VimでMarkdownを書いている時にプレビューしなくても *強調* 表示を目立たせる - the code to rock
Vim、便利ですね。 Markdown、便利ですね。 じゃあVimでMarkdownは……？ べりー便利！！ ……さて、VimでMarkdownと言ったら、僕の場合はquickrun.vimか、previm*1を使ってきました。 その辺の話は、以下でも書いています。 note103.hateblo.jp もう2年以上前の記事なので多少情報が古いかもしれませんが、この時にやりたかったことや考えていたことの多くは今もそんなに変わっていないと思います。 そしてまた、VimでMarkdownといったら、けっこう最近めに出た以下における、mattnさんの記事が大変充実していて良かったです*2。 gihyo.jp ちなみに同誌同号の同特集は、その記事にかぎらず全般的にとても良かったですね。 同じくmattnさんのIDE化記事も大変参考になりましたし、KoRoNさんのコラムも非常に面白かったです*3。
旧・Macの手書き説明書 - FC2 BLOG パスワード認証
ブログ パスワード認証 閲覧するには管理人が設定した パスワードの入力が必要です。 管理人からのメッセージ https://mac-tegaki.comへ移転中 閲覧パスワード Copyright © since 1999 FC2 inc. All Rights Reserved.
gitbook-plugin-mermaid-2の導入 - Qiita
久しぶりに完全新規でgitbook + mermaid.js環境を作ったらハマったのでメモ mermaid.jsが素晴らしいけどなかなか使ってる人見かけないので実例晒す を書いた頃に作ったプロジェクトは以下の構成 gitbook-plugin-mermaid : "0.0.4" ただし、ganttとか使いたかったので手動でmermaid.js本体の 0.4.0 を当ててた。 gitbook-cli : "1.0.1" で、完全新規でつくることになったので前回と同じ勢いで gitbook-plugin-mermaid をnpmで入れると、0.0.9 になった。 Haroopad や既存の gitbook + mermaid 環境で作っていたドキュメントが大量にあったので、それを流用しようとすると、見事にレンダリングされなくなった。なんで？ gitbook-plugin-mermaid の変更
Quiver でメモ管理改善
Quiver: The Programmer’s Notebook Twitter のタイムラインで こちらのエントリ を見かけて、これはよさそうと思って衝動買いしてちょっと試してみたところ、自分のニーズを全て満たしていると言っても過言ではないくらいよかった。ので、この感動を同じニーズを持った人達に伝えるべく、軽くレポートしてみようと思う。 Quiver 移行前のメモ管理 Dropbox に markdown 形式で保存 emacs で編集 Marked 2 を emacs から起動して閲覧 という感じで落ち着いていた。 が、いまいちしっくりきてなかったというか。メモ管理に最適化されてる感じは薄かった。シェルの世界から出ないでよいのでラクだなあというくらい。 Quiver の特徴 最たる特徴は以下。 1つの Note は複数の Cell で構成されている 現状、Cell は以下の5種類 T
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
VisualStudioCodeでMarkdownの時だけ末尾の空白をトリミングしない方法 - Qiita
suin・読者4万人『サバイバルTypeScript』公開中！ on Twitter: "すごい発明をしたかも…💡英語で技術ブログ書くとき、HackmdとGoogle翻訳を組み合わせると、Markdown+英語で書きながら、内容をGoogleのAIにチェックさせられる。英語として流暢かはさておき、少なくともGoogle… https://t.co/Ac7bVZHLA5"
GitHub - andrerpena/react-mde: 📝 React Markdown Editor
GitHub - junegunn/vim-easy-align: :sunflower: A Vim alignment plugin
GitHub - tyru/markdown-codehl-onthefly.vim: Realtime code highlight (```) in Markdown buffer with no configuration
GitHub - macteo/Marklight: Markdown syntax highlighter for iOS
GitHub - hirokidaichi/uiflow: uiflow - the simplest way to write down your ui-flow diagram like markdown
