MarkdownベースのGo製タスクランナー「xc」のススメ
Goにおけるタスクランナーの歴史 npmならnpm run、denoならdeno taskなど言語ツールにタスクランナー機能が付属していることがありますが、Goではそのような機能は提供されていません。 そこでGoのプロジェクトではMakefileがタスクランナーとして用いられることがしばしばありますが、独自の文法、.PHONYを大量に書く必要がある、Makefile警察が飛んでくる、などの問題があります。 Makefile警察「ぐぬぬぬ…」 #taskfile - Qiita タスクランナーとしてMakefileを使うことから脱却すべく、巷ではYAMLベースの「Task」やGoベースの「Mage」が用いられている印象です。 どちらも多少試したことはありますが、主に以下の点が気になりました。 Taskfile.ymlやmagefile.goといったツール独自のファイルを置く必要がある これは
gihyo.jp編集部におけるMarkdown記法 | gihyo.jp
本稿では、gihyo.jp編集部で利用しているMarkdownファイルの記述方法を主に解説します。 注意：gihyo.jp編集部内でのみ採用しているMarkdownの書き方をまとめた文書を、記事の体裁を取って公開したものです。なお、記事公開後に記述方法を追加・変更する可能性もあります。 Markdownとは？ はじめに、筆者の把握している範囲でMarkdownについて概説しておきます。 近年は一般向けのウェブサービスやテキストエディタでも利用されてきているMarkdown。端的に言えば、テキストファイル上で文書を書くための構文です。文書の読みやすさに焦点を当てており、Markdown形式のテキストファイル（＝Markdownファイル）をそのまま見れば文書とその構造が理解できるように、Markdown特有の編集記号や字下げを用いて表現します。また、MarkdownファイルをHTMLファイルに
Markdownでシーケンス図とかが書けるMermaid記法で業務フローを書いたら意外とイケたので自分なりのコツを紹介してみる | DevelopersIO
こんにちは、臼田です。 みなさん、業務設計してますか？(挨拶 今回はMarkdownでシーケンス図やフローチャートなどの図を記述できるMermaidを使って業務フローを書いてみたら、意外と書けたので自分なりのTipsを紹介したいと思います。 その前に 注意点として、まだMermaidを使い始めたばかりなので、「もっとこうしたらいいぞ」とか「こっちのほうがいいぞ」とかあれば建設的なフィードバックとしてSNSとかでいただけるとありがたいです。 あと業務フローって表現しましたが、人によって思い描く業務フローが違うと思うので、業務フローの定義に関するツッコミはご容赦ください。私が今回Mermaidで書いたのは以下の図です。(内容はブログ用に簡素化しました) この図のコードは以下のとおりです。(後ほど解説します) sequenceDiagram autonumber actor お客様 partic
Include diagrams in your Markdown files with Mermaid
EngineeringOpen SourceInclude diagrams in your Markdown files with MermaidA picture tells a thousand words. Now you can quickly create and edit diagrams in markdown using words with Mermaid support in your Markdown files. A picture tells a thousand words, but up until now the only way to include pictures and diagrams in your Markdown files on GitHub has been to embed an image. We added support for
ARCHITECTURE.mdというものを書いてみた - maru source
こんにちは丸山@h13i32maruです。システム全体を簡単な図とテキストでまとめる「ARCHITECTURE.md」というものを最近知りました。これは良さそうと思い、JasperのARCHITECTURE.mdを書いてみました。 jasperapp/jasper/ARCHITECTURE.md ARCHITECTURE.md自体の目的は「プロジェクトへの新規参加者が全体像の把握を効率的に行えるようにする」という感じです。書き方の指針や注意点などは考案者による記事を見てもらうのがよさそうです。また良いサンプルとしてrust-analyzerというOSSのARCHITECTURE.mdが紹介されています。 https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html https://github.com/rust-analyzer/ru
開発者が考える提案書テンプレート markdown版 - Qiita
概要 定型的な システム開発 では以下のような設計書が使われる。 システム要件定義 システム方式定義 ソフトウェア要件定義 ソフトウェア方式設計 ソフトウェア詳細設計 しかしそれ以前に 開発者目線、開発者発信で顧客に提案する概要資料を作りたい ケースがある。あるいは就職活動時の自身のポートフォリオを採用担当に説明することも同様かもしれません。 オードリー・タンがコード書く前にまずreadme.txtを書く話、Yahoo!がプロダクト開発の最初にプレスリリースから作る話、自分が前職で商品企画する際にまず広告から考えていた話、どれも明確なゴールイメージをまず確定させて必要要件を定義していくという意味で全部共通の考え方 — 菅俊一 / Syunichi SUGE (@ssuge) February 2, 2021 なんて話も。 技術とマーケティングのちょうど中間、開発者と顧客との意思疎通の橋渡し
Big Sky :: Microsoft Word を Markdown に変換するコマンド「docx2md」を作った。
8月に Google Developers Expert となり、新米の様にオロオロとしています。過去の GDE ミーティングの議事録を見せて頂いているのですが Google Document に保存されており、Go だけでなく他のカテゴリの GDE に関する物も含めると全てに目を通すのはなかなか骨が折れます。技術者なので問題は技術で解決すべく、これらの資料を grep 検索できる様にしました。 Google Document はエクスポートすると Microsoft Word の形式となるので、Microsoft Word から Markdown に変換するプログラムを書けばテキスト検索もできるし、なんならそのまま GitHub に貼り付けてしまう事もできます。 GitHub - mattn/docx2md docx2md Convert Microsoft Word Document
Markdownファイル1本で著者校正とデザイナー連携を済ませる一石二鳥の編集術 - the code to rock
こちらは『ライティングや編集にまつわるあれこれ Advent Calendar 2018』の23日目の記事です。 adventar.org さっそくですが、こちらをお読みの皆さんはMarkdownをお使いでしょうか？ いや、もう「ご存知でしょうか？」なんて聞く必要はないと思ってとりあえず使ってるかどうかを聞いてしまいましたが、このMarkdown、使いやすいような、使いにくいような、なかなか評価が安定しない記法（マークアップ言語）です。 しかし個人的には、Markdownは使う場所さえ適切なら、あるいは複雑なことさえしなければ、十分に我々を助けてくれるものだと思っています。 今日はぼくが直近の編集仕事でどのようにMarkdownを活用したか、という話を書いてみたいと思います。 目次 取り組みの舞台・背景 作戦 画像の入り方をどう伝えるか Previm 意図と各種の効果 取り組みの舞台・背景
大量のテキストを食っても速い Markdown Editor 作った - mizchi's blog
もう人生で何個目かわからない markdown エディタ作った。が、今回のは結構気に入っている。 https://markdown-buffer.netlify.com/ で遊べる。 用途としては、GitHub か Qiita か はてなブログかわからないが、なにか書こうと思ったときに、どのサービスも中途半端に重いので、とりあえずのバッファが必要、という感じで作った。なので速度重視。 ブラウザのストレージで永続化してる。オフラインで動く。できるだけエディタとしてはスコープを大きくせず、単に編集バッファ(textarea)でしかない、というのを意識している。 結構頑張って作り込んでしまった https://nedi.app が色々肥大化してしまっていて入力時にラグを感じるので、編集体験を見つめ直す自戒もある。 機能 数式対応 コードハイライト対応 バックグラウンドで自動保存 改行を br に
技術書の執筆、電子書籍ビルド、出版プラットフォーム - nullbooks
技術書の執筆、出版の方法が分からない 原稿のビルドやプレビュー、自動文字校正の環境を整備するのが面倒 出版社とのやり取りをする中で原稿と出版物が一致しなくなっていく 著者やレビュアーとの やり取りや取りまとめ、連絡が大変 執筆環境のツールがバラバラで使いにくい、手間が多い ブラウザで技術書の執筆、公開ができるので、誰でもすぐ技術書の執筆ができます エディターがMarkdown、各プログラミング言語のハイライトに対応しています 原稿を書籍と同じデザインでプレビューしたり、Epubをビルドできます 原稿から直接、出版物を作成できるので内容にズレが生じません 執筆中の文字数やページ数を常に知れるので、本の分量を意識して執筆できます さらに、以下の機能を追加予定です オンライン上での共同執筆、共著のための機能 文字校正 (textlint)やルール設定、一括での置換 レビューやコメントをオンライン
MkDocsでマテリアルデザインなMarkdownドキュメントサイトを作ろう - syonx
MkDocsとは MkDocs とは、 Markdown をもとにドキュメントサイトを構築する 静的サイトジェネレーターです。 Material for MkDocs とは、 MkDocs のテーマの１つであり、 Google が提唱しているマテリアルデザインを反映したものです。 このテーマが実によくできているので、じわじわと流行ってきているように感じます。 Material for MkDocsはパレットカラーの切替にも対応 特徴 Markdownファイルを放り込めば大体OK！ テーマいろいろ モバイルサイズにも対応 静的サイトに載せられる（アプリサーバ不要） 記事コンテンツの全文検索ができる！ 静的サイトなのに検索ができることに驚きです。ちょっとだけ仕組みを覗き見たところ、 生成コマンド実行時にインデックスらしきファイルを作っていました。 JavaScriptでゴリゴリやっている感じが
AtomでUMLをライブプレビューできる環境を構築する - Qiita
イントロダクション IoTアプリケーションの設計において、様々なアクターの間でどのようなやり取りが行われるのかを時系列で記述できるUMLのシーケンス図は有効です。次の図は、スマートフォンアプリケーションとデバイス、いくつかのウェブサービスにまたがるやり取りを表したものです。典型的なIoTアプリケーションはさらに複雑で、複数の人々が開発を担当することになります。シーケンス図を用いて、どこを誰が担当し、どのようにやり取りするのかを明確にしておくことにより齟齬の発生を防げます。 また、リサーチにおける分析においてもシーケンス図は有効です。往々にして、調査の対象となる現場には様々な登場人物が関わり、その間で複雑なやり取りが発生します。膨大に積み上がった断片的なデータを基にシーケンス図を作成することにより、コミュニケーションのギャップや、不必要なやり取りに時間が費やされているポイントなどを見つけるこ
はてなブログのエントリにPlantUMLを埋め込む方法 - Islands in the byte stream
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.
Visual Studio Code + Markdown Preview Enhancedはチームでデファクト化したいMarkdown環境だ！、と思う�(2017/10月時点) - Qiita
Visual Studio Code + Markdown Preview Enhancedはチームでデファクト化したいMarkdown環境だ！、と思う�(2017/10月時点)MarkdownエディタVSCodeVisualStudioCode 0.注意書き 筆者の本稿での意図はエディタ宗教論争を巻き起こすことではありません。「世の中では、これくらいのことが出来るようになってきている」とご参考にしてただくことが本稿の狙いです。それによって何かのお役に立てれば幸いだなと思っています。 皆さんは自分の使いやすい、皆さんの用途やプロジェクトの環境をにあったエディタを使用していただければとお断りしておきます。 1.Markdown環境について Markdwonは以前に書いたように今後の文書生産性を変えていく可能性のあるツールの一つです。Markdownのメリットは次の点だと思います。 1.1.M
プレミアムフライデー。好きなオープンソースにコントリビュートしよう。 - Boostnote
ぐっと気温が下がったプレミアムフライデー、いかがお過ごしでしょうか。 GitHubが、金曜日にはオープンソースへのコントリビュートを呼びかける、"Open Source Friday"という取り組みを行っています。 原文：Over the last three years, we've encouraged GitHub employees to take time at least every fourth Friday to work on open source and share what we're working on with each other. Open Source Friday has grown from this into a program anyone can take part in. 訳：3年以上、私たちはGitHubの従業員達に、少なくとも毎週第四金曜
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
最強のMarkdown編集環境としてのAtom - たけぞう瀕死ブログ
ブログなどちょっとした文章の編集から書籍の執筆までMarkdownを活用しています。これまで試した各種テキストエディタのMarkdown編集支援機能や、Markdown編集専用のツールはどれも満足の行くものではなかったのですが、最近はAtomに以下のようなパッケージを入れた環境が理想に近いMarkdown編集環境を得ることができました。 少し前にエンジニアHubさんで各社のエンジニアの方がオススメのAtomパッケージを紹介するという企画記事があり、私もMarkdown関連のパッケージを紹介させていただいたのですが、この記事では各パッケージを簡単にしか紹介できなかったので、ここでは少し詳しく紹介したいと思います。 employment.en-japan.com document-outline atom.io サイドバーにMarkdownの見出しをツリー状に表示してくれるパッケージです。書籍
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Visual Studio Code＋Markdownでキレイなプレゼンスライドを手軽に作成できる「Marp」／Markdownに慣れているのならばちょっとした拡張記法を覚えるだけ【レビュー】
gmork.in
Go言語初学者がConfluenceをMarkdownで書くためのCLIツールを開発した話 - DMM inside
