Skip to content

Version 0.1

Choose a tag to compare

View all tags
@hatixntsoa hatixntsoa released this 23 Sep 18:49
· 23 commits to master since this release
v0.1
32bf55c

Markdown Previewer Release Notes

Release Version: 0.1

Date: 09-23-2024

Overview

Markdown Previewer is a simple web-based tool that allows users to write, edit, and preview Markdown text in real-time. The application features syntax highlighting for code blocks, support for mathematical expressions using KaTeX, and a user-friendly interface for loading and copying Markdown files.

Key Features

  • Real-time Markdown Preview: Automatically updates the preview pane as you type in the Markdown input area.
  • Code Syntax Highlighting: Utilizes highlight.js for syntax highlighting in code blocks.
  • KaTeX Integration: Supports rendering mathematical expressions in both inline and display modes.
  • Load Markdown Files: Users can upload and edit .md files directly in the editor.
  • Copy Code Blocks: Easily copy code blocks to the clipboard with a single click.
  • Responsive Design: Toggle between a full-width preview and side-by-side view for a better writing experience.

Usage Instructions

  • Writing Markdown: Type your Markdown content in the textarea on the left. The preview will update in real-time.
  • Uploading a Markdown File: Click the "+" button to open the file input dialog and select a .md file to load into the editor.
  • Copying Code Blocks: Hover over any code block and click the copy button to copy its content.
  • Toggle Full Preview Mode: Use the toggle button to switch between views.

Dependencies

  • Marked.js - Fast Markdown parser and compiler.
  • highlight.js - Syntax highlighter for code blocks.
  • KaTeX - Math typesetting library.
  • PWA - Basic setup for progressive web apps.

Contributing

Contributions, bug reports, and feature requests are welcome! Feel free to fork the repository and submit a pull request.

Notes for Future Releases

  • Add more features such as custom themes, export options, and improved user preferences.
  • Optimize performance for large Markdown files.
Assets 2
Loading