User Scenario - hyelie/MDEditor GitHub Wiki

Who is it for?

For users who are not yet familiar with markdown grammar, it is an editor developed to use markdown document modification more intuitively.

Key Features

  • It is really easy to find the part that the user wants to modify.

    This function will be very helpful for users who are not familiar with markdown grammar by making only the part that they want look like markdown grammar.

How to open Editor

Simply open the .md file in the project to which the plugin is applied, and the Editor tab is automatically formed at the bottom. How_to_open_Editor

Synchronization between Editor and File

Editor, .md files are modified whenever user move the tab.

⇒User does not have to consider this part separately. Synchronization_between_Editor_and_File

Modifying with Editor

How to select the part that user want to modify

There are two ways to select

  • Click the part that user want
  • Move to the desired part via the up and down arrow keys

The selection is made by the type of markdown (headers, BlockQuote, Ordered List, Unordered List, ...). How_to_select_the_part_that_user_want_to_modify

Type distinction

The editor divides the types into two main categories

  • Single Block
    • What's inside a line or block
    • Plain Texts, Headers, …
  • Multiblock
    • This is something that consists of multiple blocks together, occupies multiple lines, and forms part of a document
    • Ordered List. Unordered List, Block Quote, …

Modifying

  • Only the selected part will be undone, and it will look like a markdown grammar
  • If user select another block after the modification, user can view the rendered text with the modification reflected

Create new block

  • Single block

    • Just need to press Enter once

    Create_new_block-single_block

  • Multi block

    • Press Enter once to create an item, so press it once more in this state

    Create_new_block-multi_block

Delete block

  • Single block

    • Press the delete button while the content has been erased

    Delete_block_-_single_block

  • Multi block

    • To delete each item, delete the contents of the item and press the delete button
    • Clear all contents and press delete button to delete the entire block

    Delete_block_-_multi_block

Multi-block seperate

  • When the format of the first or second line is destroyed

    • All lines are converted to single blocks.

  • When other lines are destroyed

    • The corresponding line is converted into a single block
    • If there are more than two lines up or down, it is split into multi blocks

    Multi-block_seperate

Single-block merge

  • If there are consecutive single blocks, merge all those blocks into one multi block

Single-block_merge

Caret Position

  • The location clicked before focus and the location after focus are the same
  • Move the focus to the optimal caret position by considering the caret position even if you move the focus with the up and down key

⇒ User will not feel uncomfortable with the position of the caret

Caret_Position

How to Save

If user move the tab to an existing .md file, close the tab, or terminate the project, the modifications are automatically applied to the .md file. =>User doesn't have to think about the storage at all!![How_to_open_Editor]