GitHub Flavored Markdown は何であって何でないか - Qiita
のんびりしていたらこんなメンションをもらっていたので、ちょっとまとめてみようと思います。 そろそろ @tk0miya さんがアップしてくる頃。GFMはspecかっちりしてるんでしたっけ(markdown全く詳しくない — Aki Ariga (@chezou) February 1, 2020 かっちりしている? この記事を読んでいる皆さんは Markdown の歴史に精通していると思うので、古い部分はざっくり割愛してしまいますが、オリジナルの Markdown は かっちりしていない ことで有名なマークアップ言語です。 必要最低限のマークアップ要素は規定されていて HTML への変換ツールも完成していた Markdown ですが、マークアップ言語の言語仕様としては貧弱で、インデントのルールやインライン要素をネストしたときの挙動、空行の有無による解釈の違い、などなど、細かい部分のルールにつ
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
HackMDってMarkdownEditorが革新的で使いやすい - Qiita
HackMDは、Markdownで書いたドキュメントを複数人で編集でき、リアルタイムプレビューが可能なツール。オープンソースとしても公開されている。 結論から言うとEditorは個人の好みで選べばいい。 いろんなEditorがでている中で、HackMDの最大の強みは、共同編集できて、気軽に始められることだ。 そして動作がめちゃめっちゃ軽い。早いは正義。 MTGの予定をセットしたカレンダーとかに、URL貼っておけば、メンバーがすぐにアクセスして編集できる。これがわりと楽しい。 MTG後にわざわざ認識合わせとかせずに、リアルタイムで相互レビューができるので、司会進行者のスキル差に関係なく、一定品質のドキュメントが完成できるのだ。 最終的なアウトプットは当然内容によって、それぞれあるべき場所が異なるので、MTG終盤にまとめまでやってしまえるので生産性の高いMTGができると思われる。 デザイナーが
スタートアップの現場で役立つ開発要件のまとめ方
こんにちは。ハウスマートの高松(@t2kmt)です。 皆さんは開発要件をまとめるのにどんなフォーマットを使っていますか？ 開発要件をいい感じにまとめるのって大変ですよね。 ドキュメント整備せずに開発に着手し始めてしまうと手戻り抜け漏れが出てしまいますが、一方で要件定義書をガチガチなフォーマットにするとドキュメントの作成自体の工数が増えてしまいます。 スタートアップはスピードが命。ドキュメントを書きまくって開発が進まないなんて言語道断です。 開発要件の整理はプロジェクトの成否に多大なインパクトを与えますが、ほとんどの現場では企画を考える人にフォーマットが委ねられていることが多いと思います。 今回は皆さんが快適に開発要件をまとめられるように、ハウスマートで利用している mini spec というフォーマットをご紹介します。 mini spec とは mini spec とは開発の要件をまとめる
Reddit - Dive into anything
Why do the Japanese use Excel for documents that should be done in Word? My work involves funding from the Japanese government, and they require regular reports describing the results of my work -- and they insist it be submitted via Microsoft Excel spreadsheet rather than Microsoft Word. I sometimes become infuriated when I consequently must waste time resizing and merging cells, effectively figh
markdownの拡張記法の現状 - Islands in the byte stream
Kibelaは次のようにいくつかmarkdownを拡張しています。 PlantUML記法に対応しました - Kibela Blog 記事の外部共有とLaTeX記法による数式表示に対応しました - Kibela Blog そして、今後もそういう拡張は増えていくと思われます。 PlantUML KibelaのPlantUML記法はこういうやつです。 ```plantuml Bob -> Alice : hello Alice -> Bob : Go Away ``` GitLabも同じ構文でPlantUMLをサポートしていますね。 PlantUML & GitLab - GitLab Documentation crowiも最近PlantUML記法をサポートしはじめましたね。構文はKibelaとおなじです。 Support PlantUML by sotarok · Pull Request
なぜソースじゃなく詳細設計を欲しがるのか
Javaを始めとするオブジェクト指向言語による開発になると、設計の手法も従来とは大きく変わる。 その結果、不要になるドキュメントが出てくる。 詳細設計のことだ。 ここでいう詳細設計とは、本来コードで記述する処理を、逐一日本語で書き下したものを指す。 てか、そんな物を読むくらいなら、現物のソース読めよって話だ。 だいたい、ソースに書くレベルの粒度の記述を、なんでいちいち日本語なんて表記揺れも甚だしいフォーマットで書かにゃならんのだ。 何よりソースに修正が入ると、遡って詳細設計も直さないと整合性が取れなくなるので、言うなれば二重に工数を掛けることになる。 「違うよ、設計を直して実装するんだよ」というが、合理性を重んじるSEやPGという人種が、実質同じ内容を何度も書きたがるわけがない。 それに、単体テストくらいまでの段階ならともかく、開発要員が縮小される結合テスト・システムテスト以降で、そんなこ
読みやすいREADMEを書く | Yakst
いくつかのオープンソースプロジェクトを公開している筆者からの、読みやすくユーザーにやさしいREADMEを書くためのアドバイス。 この記事は、Rowan Manning氏による「Writing a Friendly README」(2016/3/14)を翻訳したものです。 あなたのプロジェクトのREADMEは、かなり重要です。そこはプロジェクトに初めて来た人が大抵最初に見るであろう場所であり、唯一のドキュメントであることもよくあります。あなたのオープンソースプロジェクトにとってのREADMEは、企業にとってのウェブサイトのようなものです。ウェブサイトはユーザーエクスペリエンスの注目を集めるところですが、READMEがユーザー観点で考えられることはほとんどありません。 この記事では、分かりやすいREADMEを書くために役立ち、開発者(ユーザー)の要求に見合い、開発者がプロジェクトを初めて見たの
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 138 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - mattn/docx2md: Convert Microsoft Word Document to Markdown