You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました サービスバージョンアップの歴史、個人の年表などタイムライン表示を使いたいことはよくあります。それ用のライブラリもありますが、記法が面倒だったり、後々のメンテナンスが面倒というイメージがあります。 そこで使ってみたいのがmdlineです。記法はMarkdownを使っていますので、使い方はすぐに覚えられます。 mdlineの使い方 こんな表示です。見出しがあって、内容があるという分かりやすい並びです。縦型なのも好感が持てます。 レスポンシブで、ウィンドウ幅を縮めればコンテンツが右側に並びます。 Markdownは通常のもので、トリッキーな書き方はありません。 ## 1997-06: ECMAScript 1 First edition. ## 1998-06: ECMAScript 2
Write overviews of systems including concepts, terminology definitions and description of how these concepts work together. Having a 'living document' to help drive dialogue and exchange of ideas through collaboration helps this process significantly. Organize your dev team's sprint backlog and visualize them with status, assignees, reviewers, due date and everything you need. Reduce repeated prog
MOONGIFTはオープンソース・ソフトウェアを紹介するブログです。2021年07月16日で更新停止しました プレゼンテーションのスライドを作る方法としてはPowerPointやKeynote、Googleスライドと言った専用のソフトウェアを使うのが手軽です。ただし相手が同じ環境でないと使えなかったり、ソフトウェアを手に入れる必要があります。Googleスライドは便利ですがフォントの種類が少なかったりするのが残念です。 そこで使ってみたいのがHTMLプレゼンテーションです。今回は特に機能が多そうなMarkDeckを紹介します。 MarkDeckの使い方 デモのスライドです。矢印キーでのスライド切り替えはよくある操作です。 コードハイライト。 ditaaを使ったアスキーアートからグラフィカルな画像にする機能。 plantumlを使ってテキストからUML表現も。 graphvizも使えます。
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
クロスプラットフォームに対応しシンタックスハイライトやタグ、マルチ編集機能をサポートしたオープンソースのノートアプリ「Notable」がリリースされています。詳細は以下から。 Notableはイタリア・カターニア大学のFabio Spampinatoさんが公開したオープンソースのノートアプリで、Fabioさんは以前からノートアプリにEvernoteを利用していたそうですが、より軽量でMarkdownをサポートしたノートアプリを探しているうちにNotableの開発に行き着いたそうで、 The markdown-based note-taking app that doesn’t suck. I couldn’t find a note-taking app that ticked all the boxes I’m interested in: notes are written and r
はじめに ドキュメントって皆さんどうしていますか? Qiitaで記事を書いている方なら、Markdownを普段から使う人も多いと思います。 私の職場では、「Wordでドキュメントを書く」という習慣がありました。 最近、「Markdownで書く」というのを定着させることができましたので、その過程で何をやったのかを共有したいと思います。 2018/11/02 追記 本記事に、Microsoft Wordを批判する意図はございません。 WordよりもMarkdownが優れているという主張をするつもりもございません。 それと、後出しで恐縮ですが、本記事に登場する職場とは、ソフトウェアエンジニアがメインの部署です。 ドキュメントというのも、技術系資料です。 その前提でお読みください。 誤解があるといけないので追記いたしました。 (追記終わり) やったこと1:議事録をMarkdownで取った 私の職場
こんにちは!開発部テクニカルコミュニケーショングループの仲田です。 皆さんマークダウン使ってますか?(唐突) 文書記法の一つで、プログラマーにとっては馴染みがあるものだと思います。サイボウズのプロダクト仕様書もマークダウンで書かれることが多くなっています。 ですが、公式ドキュメントを作る用途として採用される例はまだ少ないように思います。数ヶ月前になりますが、プロダクトのヘルプサイトをマークダウンに移行しましたので、今回はその話をします。 なぜ移行したのか マークダウンに移行した動機は、一言で言うとヘルプサイトの制作や更新を効率化するためです。 サイボウズでは、プロダクトのアジャイル開発化を進めています。アジャイル開発では、ウォーターフォール開発と比べてリリース間隔が短縮されます。パッケージ製品がメインだった頃には、リリースは年単位で、短くても数ヶ月ごとというスパンでした。ところが、クラウド
Markdown 記法の中で強調するための記号には2種類ある。アスタリスク * とアンダースコア _ だ。 **これで強調される** __これでも強調される__ これらの2つの違いと、なぜ2つあるのか、というところを調べてみた。 アスタリスクとアンダースコアの違い 「別にアンダースコアでも強調できるけど?」に対する説明 「Markdown の仕様」はどうやって決まっているのか・差異が生まれた理由 CommonMark が分かち書きしていないアンダースコアを強調しない理由 まとめ その他参考 アスタリスクとアンダースコアの違い アスタリスクで強調した時とアンダースコアで強調した時の違いは、「分かち書きが必要かどうか」にある。 「分かち書き」とは、スペースで単語を区切る、通常の英文章の書かれ方のこと。日本語の場合、普段スペースで単語を区切ることはないので、「分かち書きがない文章」ということにな
VuePress とは この記事は 2018-04-15 に記載されたものです。 VuePress は Vue の始祖こと Evan You 氏が新たに始めた Vue による静的サイトジェネレーターです。 Markdown によるページの作成が可能で、Vue の機能はもちろん、Webサイトを作っていてほしくなるシンタックスハイライトや、PWAのサポートがされています。 雑な解釈としては Vue 版の Gatsby という認識で良いのではないのかと思います。 VuePress の機能 公式に記載されている内容を抜粋して雑に翻訳してみました。 ref: VuePress | Introduction 技術文書に最適化されたビルトインのMarkdown拡張 Markdown 内部での Vue 活用 Vue により強化されたカスタムテーマシステム Progressive Web Applicati
連載「Dev Basics/Keyword」 Mark Textは、macOS/Windows/Linuxで動作するMarkdownエディタ。Electronをベースとしている。また、Markdownフォーマット以外には、HTML/PDFへのエクスポート機能も備えている*1。 *1 本稿執筆時点(2018年3月29日)では、日本語の入力時に「入力したテキストが消失してしまう」ことがある。これを回避するには、入力が終わった時点で、IMEの日本語入力モードから半角英数入力モードに切り替えるか、半角スペースか全角スペースを入力(して[Backspace]キーでそれを削除)する必要がある。また、初回起動時にmarktextフォルダがないために例外が発生するかもしれないので、エラーダイアログを見て、該当するフォルダを作成してやるとよい。 Mark Textの概要 Mark Textは、リアルタイムに
MkDocsとは MkDocs とは、 Markdown をもとにドキュメントサイトを構築する 静的サイトジェネレーターです。 Material for MkDocs とは、 MkDocs のテーマの1つであり、 Google が提唱しているマテリアルデザインを反映したものです。 このテーマが実によくできているので、じわじわと流行ってきているように感じます。 Material for MkDocsはパレットカラーの切替にも対応 特徴 Markdownファイルを放り込めば大体OK! テーマいろいろ モバイルサイズにも対応 静的サイトに載せられる(アプリサーバ不要) 記事コンテンツの全文検索ができる! 静的サイトなのに検索ができることに驚きです。ちょっとだけ仕組みを覗き見たところ、 生成コマンド実行時にインデックスらしきファイルを作っていました。 JavaScriptでゴリゴリやっている感じが
開発ドキュメントの整備は大きな問題です。ソースコードに書かれたりWikiや何らかのCMSを使ったりと様々な方法がありますが、これといった解決策はなかなか見つけられません。 そこで使ってみたいのがDocusaurusです。Facebook製のオープンソース・ドキュメントサイトです。 Docusaurusの使い方 メインページです。 文書はMarkdownで作成します。 ドキュメント部分です。左側に目次、右側にコンテンツが表示されます。 リンクはページ下に付きます。 DocusaurusのコンテンツはMarkdownとなっています。それだけにメンテナンスが容易です。また、UIはReactで作られていますので、表示が高速に行われます。オープンソースのプロジェクトに最適なドキュメント管理かも知れません。 Docusaurusはnode/JavaScript製のオープンソース・ソフトウェア(MIT
以前からテキストベースで仕様書(PDF)などを管理したいと思っていたのですが、ようやくその環境が整い、一度実際に運用してみてかなりいい感じだったので紹介したいと思います。 基本テキストは AsciiDoc で記述する UML は PlantUML で記述する フローチャートとかは必要に応じて mermaid.js も使う つまり基本テキストで表現・管理できるものはテキストで書く 成果物は PDF形式。目次(Table of Contents) はつける。 動作確認環境 macOS Sierra 10.12.3 ruby 2.3.1 Asciidoctor 1.5.5 Asciidoctor PDF 1.5.0.alpha.14 Asciidoctor Diagram 1.5.4 mermaid 7.0.0 AsciiDoc とは AsciiDoc Home Page 軽量マークアップ言語の
@machidaさんが 「全てのテキストエリアはgithubみたいに画像のD&D・コピペができて欲しい。あとMarkdownで書きたい。」 と常々言っていて、僕もちょっとしたコメント欄でもMarkdownが使えたら嬉しいけどいちいち実装が面倒なので、 「確かにそうですよねー」 と言って流していました。 しかし流すのにも限界がきたので、TEXTAREを画像のD&DとコピペができるMarkdown Editorにするnpmモジュールを作りました。 komagata/textarea-markdown: Make textarea a markdown editor. railsで使うなら下記のような感じです。 <textarea id="editor" data-preview="#preview"></textarea> <div id="preview"></div> import Tex
PlantUML、便利ですよね。はてなブログでも使いたいですよね。ということでやってみました。 まずエントリの最後にこのスニペットを置きます: <script> var a = Array.from(document.querySelectorAll("pre.code")); a.forEach(function (pre) { if (pre.attributes['data-lang'].value) return; var xhr = new XMLHttpRequest(); xhr.open("POST", "https://plantuml-service.herokuapp.com/svg"); xhr.onload = function () { if (xhr.status === 200 && pre instanceof HTMLPreElement) { pre.
What is Sudachi? Sudachi is a timetable editor to list up your tasks in a day and organises their priorities at the beginning of the day. Make a timetable with Markdown Sudachi allows you to write a timetable with Markdown. The tasks in the editor area are shown in the timetable area. Edit a timetable easily The start time and required time of tasks can be edited easily by drag and drop in the tim
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く