Markdown で原稿を書く場合の取説が欲しい about md2inao HOT 11 CLOSED

ご丁寧にありがとうございます。

了解いたしました！
WEB+DB PRESSの作業がひと段落した4月に、作成させていただきます。

from md2inao.

備忘録：過去のIssueを見返して記載することを洗い出すこと

from md2inao.

この辺ぼちぼちどうですか?

別の本書いてるプロジェクトで、その後に追加された仕様 (メタデータ周りとか) が undocumented なもんで参照できずに若干微妙な感じになっております。

from md2inao.

メタデータ、例の一行アキとか色々と仕様が追加されていくと思うので、それらの新仕様をドキュメントに反映させながら進めていかないと uncodumented なものがたくさん増える上にそれが @inao の暗黙知になって収集つかなくなると思われます。

from md2inao.

すみませんすみません。
ちょっと粗いかもしれませんが、今日明日には叩き台を書きます！

from md2inao.

お願いします！

from md2inao.

どこに書くのがよいでしょう？

• プロジェクトのREADME.mdにマージ
• manual/README.mdとか
• GitHub Pages
  • http://inao.github.io/idtagreplacer/ みたいな

のどれかですかねー。

GitHub Pagesの場合、オーナーの伊藤さんしか作れないです。たぶん。
あと普通にやるとオーナー以外はMarkdownではなくHTMLで書かなきゃになるので、以下のようなしくみを導入していただけると助かります。

とりあえずはMarkdownでWikiにでも書いていきますね。

from md2inao.

README に merge でいいんじゃないですかね。
大概みんな README しかみないし。

どっかに Markdown で書いてもらえたら、適当に README.md に merge しますよ

from md2inao.

了解です！

from md2inao.

校正しました。

• 取説ドキュメントの登場位置を調整
• 概要を追加
• HTMLエスケープについて追加
• サンプルを追加
• code ブロックを Github Flavored から変更 (md2inao に食わせてもちゃんとなるように･･･)

などなど。おそらくドキュメントに書かれてない仕様がまだ色々あるので、見つけ次第追記していきましょう。

from md2inao.

ご校正ありがとうございます！
見つけ次第追記も了解ですっ。

from md2inao.