Skip to content

Instantly share code, notes, and snippets.

@hashrock
Last active March 27, 2021 13:27
Show Gist options
  • Star 3 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save hashrock/83c99f2b1aca89281a7e70fa200d4805 to your computer and use it in GitHub Desktop.
Save hashrock/83c99f2b1aca89281a7e70fa200d4805 to your computer and use it in GitHub Desktop.
markdown風の文字列からカンバンやガントチャートを生成するための仕様集(草案)

markdown風の文字列からカンバンやガントチャートを生成するための仕様集(草案)

利点

  • DBに格納するより、単純にテキストにしたほうがポータビリティがある
  • その辺の独自操作の多いガントチャートエディタより、一括置換やコピペのできる普通のテキストエディタの方がよさそう
  • markdown中にcodeとして埋め込んでレンダリング&印刷とかやりたい
  • いざとなれば客にはメールでテキストのまま送れる

基本仕様

  • 仕様はなるべくミニマルに。テキストのまま見ても違和感なく読めるようにしたい
  • 見出し、リンク、リストなどの仕様をMarkdownに寄せる
  • Markdownパーサに食わせてエラーが出なければいいかな。そしてそのままASTを利用したい

カンバン仕様

https://github.com/anydown/kanbandown

#TODO
 * タスク1
 * タスク2
  * ここにタスクの詳細を記述する
  * :heavy_check_mark: タスク2のサブタスク1
  * :white_medium_square: タスク2のサブタスク2
#DOING
 * タスク3 〜1/22
#DONE
 * タスク4
#ARCHIVE
 * タスク5

必須

  • 見出しが一つのListとして展開される
  • 見出し下のリスト表記がCardとして展開される
  • emojiは展開される
  • 一階層下のリストは、descriptionとして展開される

オプション

  • ARCHIVEに投入したタスクは不可視となる。設定された絵文字のみでアイコン表示など
  • 絵文字に特別な意味を持たせる
  • 1️⃣ 2️⃣ はストーリーポイントとしてカウント
  • ✔️ ◻️ はクリックするとトグルする
  • 〜1/23のような表記は締切日として扱い、設定日前になるとカードを赤く表示

未定

  • リンクの仕様はどうするか?
  • 画像アタッチの仕様はどうするか?

ガントチャート仕様

https://github.com/hashrock/ganttpad

タスク1 2016/01/01 2016/01/02
タスク2 1/1〜1/2
マイルストーン 1/3

必須

  • 空白区切りで、タスク名・開始日・終了日の順に認識される。
  • 「〜」は空白に変換される。
  • 全角スラッシュは半角に変換される。
  • 日付形式はYYYY/MM/DD、MM/DD、YYYY-MM-DD、MM-DDを認識する。
  • 終了日がない場合はマイルストーン扱いとする。

未定

  • タスクの色分け
  • タスク間の依存関係までやる?
  • 表示期間を固定させたい
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment