/vscode-uukii-md

Uukii Markdown Preview is a Visual Studio Code extension that provides real-time preview of Markdown documents.

Primary LanguageTypeScript

Uukii Markdown Preview

Uukii Markdown Preview is a Visual Studio Code extension that provides real-time preview of Markdown documents.

Features

  • Real-time preview of Markdown documents.
  • Quickly open the preview with the shortcut Ctrl+Shift+P.
  • Supports common Markdown syntax and extensions.

Installation

  1. Open Visual Studio Code.
  2. Go to the Extensions Marketplace.
  3. Search for Uukii Markdown Preview.
  4. Click the "Install" button.

Usage

  1. Open a Markdown file (with the .md extension).
  2. Use the shortcut Ctrl+Shift+P to open the real-time preview.
  3. The preview window will appear beside the editor and update in real-time.

Shortcuts

  • Ctrl+Shift+P: Open or close the Markdown preview.
  • Ctrl+Shift+L: Switch to Light Mode.
  • Ctrl+Shift+D: Switch to Dark Mode.

Known Issues and Limitations

  • Custom styles are not supported yet.
  • Large files may cause performance issues.

Future Development

Document Formatting

  1. Automatic Formatting: Automatically format Markdown documents, including adjusting heading levels, paragraph spacing, and list indentation for a more standardized and aesthetically pleasing document.
  2. Word Count and Reading Time Estimation: Display the word count and estimated reading time in the real-time preview bar to help authors understand the document's length and the reader's time investment.

Content Enhancement

  1. Image Optimization: Automatically adjust the size of inserted images to fit different preview windows and provide simple image editing functions such as cropping and rotating.
  2. Link Preview: Display a preview of the target page when hovering over links in the document to help authors quickly understand the content the link points to.
  3. Enhanced Code Block Highlighting: Provide more language support for code blocks in Markdown documents and enhance the highlighting effect to make it easier to read and understand.

Collaboration Features

  1. Real-time Collaborative Editing: Allow multiple users to edit the same Markdown document simultaneously and display other users' editing status and changes in the real-time preview bar for easy team collaboration.
  2. Comments and Annotations: Users can add comments and annotations in the document to facilitate communication and feedback with other authors.

Personalization Settings

  1. Custom Shortcuts: Allow users to customize more shortcuts in addition to existing ones to meet different usage habits.
  2. Theme Customization: Provide more theme options or allow users to customize theme colors, fonts, etc., to make the plugin more personalized.
  3. Plugin Configuration Saving: Users can save their plugin configurations, including theme selection and shortcut settings, to quickly restore their preferences when using on different devices.

Contribution

Contributions are welcome! Please follow these steps:

  1. Fork this repository.
  2. Create a new branch: git checkout -b https://github.com/Selteve/vscode-uukii-md.git.
  3. Commit your changes: git commit -m 'Add some feature'.
  4. Push to the branch: git push origin https://github.com/Selteve/vscode-uukii-md.git.
  5. Submit a Pull Request.

License

This project is open-sourced under the MIT License. See the LICENSE file for details.

Enjoy using Uukii Markdown Preview!

console.log("Uukii Markdown Preview is the best!");
{
  "uukii": "markdown-preview",
  "best": true,
  "version": 1.0
}