Markdown Reader

Privacy Policy

Updated on:December 30, 2024

Introduction

Thank you for using Markdown Reader (hereinafter referred to as "the Extension"). We highly value your privacy. This privacy policy describes how we collect, use, and protect your information.

Data Collection

The Extension does not actively collect or store any personal file information. All file parsing operations are performed locally on the user's device.

If you sign in to the Extension's user system, we will collect your email address used during registration. This will serve as your unique identifier, login credential, and a means to recover your password.

User Data

The Extension may access the following content:

Local Files: When you choose to open local Markdown files, the Extension temporarily reads the file contents for rendering but does not upload or store any file content.
Online Resources: If you choose to load online Markdown files or related resources (e.g., images), the Extension will send requests to the target server. These requests are consistent with normal browser behavior, and the Extension does not store any network data.

Diagnostic Information

With explicit user consent, we may collect anonymous error reports and usage statistics to improve the Extension's functionality. These reports will not include any personally identifiable data.

How We Use Information

We do not collect, store, or share your personal information. You can use the Extension with confidence, as all file processing tasks are performed locally on your device.

Information Sharing

We do not share user personal information or usage data with any third party.

Third-Party Services

The Extension may load online resources provided by users (e.g., images in Markdown files). Please note that these resources are hosted by third parties designated by you and are subject to their privacy policies. The Extension does not control these resources.

Your Rights

Since the Extension does not collect user file data, there are no issues regarding access, correction, or deletion of personal data. If you have any questions, please contact us using the information below.

Security

Your data security is of utmost importance to us. The Extension does not actively transmit any user file data or access sensitive user information.

Privacy Policy Updates

We may update this privacy policy from time to time. Any changes will be published on this page, with the latest update date clearly indicated. Please check back periodically to stay informed about our privacy practices.

Contact Us

If you have any questions or suggestions regarding this privacy policy, please contact us via the following:

GitHub:GitHub Issues.
Email:mkdreader@gmail.com
WeChat: Scan the code to get the support.
WeChat Official

Frequently Asked Questions

About Markdown Reader
- 1. What is Markdown Reader?
  Markdown Reader is a browser extension that renders local and online Markdown files into beautiful, readable HTML pages.
- 2. Which browsers are supported?
  It is currently available for Chrome and Firefox, more browsers will be adapted in the future.
- 3. Join the WeChat Community.
  Scan the code to get the latest news and technical support:
  WeChat Official

Installation and Usage
- 1. How do I install Markdown Reader?
  Search for “Markdown Reader” in the Chrome Web Store or Firefox Add-ons and click install.
- 2. How can I open local Markdown files?
  To open local Markdown files, drag and drop the file into your browser or use the file:// protocol. However, if the local file doesn’t render, follow these steps to enable local file access:
  - In Chrome:
    1. Go to chrome://extensions/ by typing it in the address bar and pressing Enter.
    2. Find Markdown Reader in the list of installed extensions.
    3. Click the Details button beneath the Markdown Reader entry.
    4. Scroll down to the option "Allow access to file URLs" and toggle it on.
    5. Reload the local file in your browser.
  - In Firefox: Local file access works by default. Ensure your file path starts with file://, such as file:///C:/path/to/your/file.md. If issues persist, check for other potential restrictions like enhanced privacy settings.
  These steps ensure seamless local Markdown file rendering in your browser.
- 3. How do I preview online Markdown files?
  Enter the file URL (e.g., https://example.com/file.md), and the extension will automatically render the content.

Feature Settings
- 1. How can I switch themes?
  You can switch between light and dark themes in the settings, or choose “Auto Mode” to follow the system theme.
- 2. Can I disable certain plugins?
  Yes! Go to the Popup settings page and toggle plugins on or off as needed.
- 3. How can I adjust the font size?
  Use the slider in the settings to adjust the font size. This will change the display scale of the entire document.

Technical Support
- 1. What Markdown extensions are supported?
  Markdown Reader supports advanced syntax extensions like KaTeX for math formulas, Mermaid for flowcharts, Gantt charts, footnotes, task lists, and more.
- 2. How often does real-time rendering update?
  The extension polls the source file every 0.5 seconds to ensure the displayed content is up-to-date.
- 3. Which languages are supported for syntax highlighting?
  It supports syntax highlighting for a wide range of programming languages, including JavaScript, TypeScript, Java, Python, C, C++, Shell, and more.

Common Questions
- 1. Why can’t some Markdown files render correctly?
  Ensure the file is encoded in UTF-8 and check if unsupported syntax extensions are used.
- 2. Can I add custom themes?
  Currently, only light and dark themes are supported, but more customization options are planned for future updates.
- 3. How do I provide feedback or report issues?
  You can submit an issue on our GitHub page or email us at mkdreader@gmail.com.

Future Features
- 1. Will there be more themes or personalization options?
  Yes! We’re working on adding more themes and UI customization features.
- 2. Will you support more plugins?
  We continuously update and expand the available plugins to enrich the Markdown rendering experience.

Privacy Policy

Introduction

Data Collection

User Data

Diagnostic Information

How We Use Information

Information Sharing

Third-Party Services

Your Rights

Security

Privacy Policy Updates

Contact Us

Frequently Asked Questions

About Markdown Reader

1. What is Markdown Reader?

2. Which browsers are supported?

3. Join the WeChat Community.

Installation and Usage

1. How do I install Markdown Reader?

2. How can I open local Markdown files?

3. How do I preview online Markdown files?

Feature Settings

1. How can I switch themes?

2. Can I disable certain plugins?

3. How can I adjust the font size?

Technical Support

1. What Markdown extensions are supported?

2. How often does real-time rendering update?

3. Which languages are supported for syntax highlighting?

Common Questions

1. Why can’t some Markdown files render correctly?

2. Can I add custom themes?

3. How do I provide feedback or report issues?

Future Features

1. Will there be more themes or personalization options?

2. Will you support more plugins?