Tutorial

事前準備

FlexiMarkはVSCodeの拡張機能です。まず、VSCodeがインストール済みであることを確認してください。インストールされていない方は下記からインストールしてください。

https://code.visualstudio.com

その後、FlexiMarkをインストールします。下記のリンクを開いた後、「Install」ボタンをクリックしてください。

https://marketplace.visualstudio.com/items?itemName=Kashiwade.fleximark

おすすめの拡張機能

Markdownの記述をより便利にするために、いくつかのおすすめの拡張機能が存在します。併せてインストールすることを検討してください。

動作確認

適当なMarkdownファイルを開いてください。FlexiMarkが正しくインストールされていれば、タブの右端にアイコンが表示されます。そのアイコンをクリックすることでプレビューが開きます。

FlexiMarkはMarkdownのプレビュー機能は、後述するFlexiMark Workspaceの外でも使用することができます。

FlexiMark Workspaceの作成

FlexiMark専用のディレクトリを作成し、FlexiMark Workspaceとして設定します。今後、Markdownノートの作成はこのディレクトリ/Workspace内で行います。

空のディレクトリを作成し、VSCodeで開いてください。その後 F1キーを押下し、下記を入力してください。入力したらEnterキーを押してください。

FlexiMark: Initialize Workspace as Note Taking Directory

すると下記のような画面になります。エディタにはコメント付きの.vscode/settings.jsonが表示されています。このコメントはFlexiMarkの各設定項目の説明を記しています。

まずはノートのカテゴリをカスタマイズしてみましょう。.vscode/settings.jsonの下記の部分をお好みに修正してください。日本語などの2バイト文字も可能です。

.vscode/settings.json
{
  "fleximark.settingsVersion": 1,
  // Notes are organized by category.
  // You can add as many categories as needed.
  // Categories are structured as a tree.
  // Notes are saved according to this category structure.
  "fleximark.noteCategories": {
    "General": {
      "Daily Notes": {},
      "Progress Report": {}
    },
    "Tips": {
      "Programming": {
        "Python": {},
        "JavaScript": {}
      },
      "Life": {}
    }
  },
  ...

それでは記念すべき最初のノートを作成してみましょう！F1キーを押下し、下記を入力してください。入力したらEnterキーを押してください。

FlexiMark: Create New Note

すると、先ほど設定したカテゴリ構造に基づいてカテゴリを選択するダイアログが表示されます。矢印キーで選択してEnterキーを押すと、その子カテゴリの選択に移ります。末端の子カテゴリの選択が完了するまで、このカテゴリ選択は続きます。途中のカテゴリで選択を終了したい場合は、ダイアログ一番下の項目を選択します。