20
13

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

Backlog記法をMarkdownに変換したい

Last updated at Posted at 2019-01-27

TL;DR

次ののブックマークレットをお試しください。
→ Backlog記法をMarkdownへ変換する.min.js(GitHub)

  • 行頭をクリックするとメニューが表示されます
  • その中から「Copy line」を選択するとコピーできます
  • URIエンコード済みなので、ブックマークに登録してからご利用ください

全社的にMarkdownをメインに使っていきたい

何かしらの歴史的な理由からヌーラボ社のBacklogでBacklog記法を使ってきたものの、「やっぱりMarkdownで仕事がしたくなったぞ」という時の手助けになればとBacklog記法からMarkdownへの変換を手助けするブックマークレットを用意しました。

テスト数の不足から完全な置き換えは保証できませんが、ほぼほぼ置き換えることができます(150程度のWikiや課題詳細で確認)。

でも、これまでのBacklog記法はどうするの?

結局のところこれが問題です。

Backlog記法とMarkdownでは非順序リスト以外互換性がほとんどありません。プロジェクトの設定を変更しただけでは業務に支障がでてしまいます。

そんな時

  • とりあえずよく使うページや課題だけでも変換できればOK
  • 新しいプロジェクトからMarkdownにして、横断的に使っているプロジェクトは手分けして置き換えしていけば解決できそう
  • ある程度課題詳細の内容のフォーマットが決まっているためBacklog APIを使って全置換してしまえばよさそう

といったケースをお手伝いできるかもしれないのが本コードです。

元のJSはこちらに置いてあります。
→ Backlog記法をMarkdownへ変換する.js(GitHub)

Backlog APIなどで利用する場合は、一番外側のIIFEに渡している第二引数を取り出してご利用ください。

最後に

BacklogでMarkdownが使えるようにできれば、Backlogを利用していない職場から中途入社してきた方の学習コストも削減できますし、Markdownをサポートしている数々のアプリケーションと同じ記法で記述・連携できて一石二鳥です。
もしまだあなたの現場でBacklog記法が利用されていて、Markdown記法に切り替えられそうな見込みがある場合はぜひぜひ切り替えていっていただければと思います。

MarkdownでよりよいBacklogライフをお楽しみください。

ご注意

  • ご利用は自己責任でお願いいたします
  • ミスったらまずいページや課題詳細は必ずプレビューを行ってください
  • Backlog記法とMarkdownはできることに違いがありますから、そこも含めて検討したほうがが良さそうです
    • たとえば、BacklogでのMarkdownはHTMLを無視されるので、文字色が変更できません
      • 非アクセシブルではありますが、文字色が重要な現場では慎重にご検討ください
  • BacklogのMarkdownならではの記法やルールも存在するため、本コードで変換したものがMarkdownサポートをしているGitHubなどの各種サービスでもそのまま使えるわけではないことにご注意ください
20
13
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
20
13

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?