Coming soon...

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.