日本語

vscode-md2backlog

Markdown記法とBacklog記法を相互に変換するVScodeのタスク

• *.mdの拡張子を持つファイルを開いて実行するとBacklog記法へ
• *.txtの拡張子を持つファイルを開いて実行するとMarkdown記法へ

変換対象のファイルと同じパス上に書き出されます

動作に必要な環境

• Python

セットアップ

1. ダウンロード
2. VScodeで、導入したいワークスペースを開く
3. ルートディレクトリに.vscode/を作成
4. その中にmdbl.pyを入れる
5. tasks.jsonを更新する or 入れる
6. python -V でPythonが実行可能かどうか確認する
7. CTRL+SHIFT+Pでコマンドパレットを開いてウィンドウの再読み込み

使い方

1. 変換したい*.mdもしくは*.txtを開く
2. CTRL+SHIFT+Bでタスクパレットを開く
3. 実行するタスクを選択
   1. md2backlog: Output with the same filename
      • 変換対象と同じパス上に新規ファイルを生成します
      • ファイル名は変換対象のものが引き継がれて拡張子だけ変わります
   2. md2backlog: Output with a custom filename
      • 変換対象と同じパス上に新規ファイルを生成します
      • 実行時、保存するファイル名の入力を促されます
   3. md2backlog: Output as a string to the console
      • 変換したものをコンソールで文字列で出力します

 

▼ English

vscode-md2backlog

A VSCode task to convert between Markdown and Backlog notation.

• Running the task on a file with the *.md extension converts it to Backlog notation.
• Running the task on a file with the *.txt extension converts it to Markdown notation.

The converted file will be generated in the same directory as the source file.

Prerequisites

• Python

Setup

1. Download the files.
2. Open the target workspace in VSCode.
3. Create a .vscode/ directory in the root directory.
4. Place mdbl.py inside the .vscode/ directory.
5. Update or add the tasks.json file.
6. Run python -V to verify that Python is accessible.
7. Open the Command Palette with CTRL+SHIFT+P and reload the window.

Usage

1. Open the *.md or *.txt file you want to convert.
2. Open the Task Palette with CTRL+SHIFT+B.
3. Select the task you want to run:
   1. md2backlog: Output with the same filename
      • Generates a new file in the same directory as the source file.
      • Retains the original filename, changing only the extension.
   2. md2backlog: Output with a custom filename
      • Generates a new file in the same directory as the source file.
      • Prompts you to enter a filename upon execution.
   3. md2backlog: Output as a string to the console
      • Outputs the converted text directly to the console.