Skip to content

QianqiuerQS/Markdown-reading

Repository files navigation

Markdown Reading Extension

Logo

A VSCode extension that allows you to directly read and edit compiled Markdown files in the editor with a focus on premium readability and a "Word-like" experience.

Features

  • Dual-Mode Experience: Seamlessly switch between a distraction-free Read Mode (default) and a powerful Edit Mode.
  • Direct WYSIWYG Editing: Edit your Markdown files directly in the rendered view. No need to toggle between source and preview.
  • Premium Readability: Optimized 16px font size, refined line height (1.6), and compact margins for a balanced reading experience.
  • Rich Formatting Toolbar: Access common formatting tools including Bold, Italic, Headings, Lists, and Text Colors in Edit Mode.
  • Fixed Light Theme: Optimized for focus with a consistent paper-white background and deep black text, regardless of your VS Code theme.
  • Smart Toggle: Right-click a Markdown file to open the preview; use the context menu inside the webview to switch between Read and Edit modes.
  • Single-Tab Experience: Reuses a single "Reading" tab when switching between different files, keeping your workspace clean.

How to use

  1. Open any .md file in VSCode.
  2. Right-click anywhere in the editor and select "Markdown-reading".
  3. The file will open in Read Mode by default.
  4. To edit, right-click anywhere in the reading view and select "Edit Mode".
  5. A formatting toolbar will appear at the top. Your changes are automatically synced back to the source Markdown file.
  6. To return to a locked view, right-click and select "Read Mode".
  7. To close the view, simply right-click the source file again and select the same command.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors