Some of the important features of the Markdown Editor addon are listed below. This is followed by an overview of this addon. This summary contains few words about the addon, its function, and its features. Next is FAQ, this section is useful to get information about how this addon works in your browser. If you couldn’t find a specific answer, please fill the bug report form on this page or the contact form on the homepage to let us know about your question. Following the FAQ, is the bug report form. It is designed to collect user feedbacks and bugs about this addon. Users can suggest improvements or feature requests through this form too. The next section is for submitting comments about this addon which uses the Facebook comments plugin. The last section is dedicated to reports submitted through the GitHub website. We hope the information provided on this page, could help you get all the basics you need about this addon and enable you to have a better experience with Markdown Editor.
In short, Markdown Editor is a lite editor and compiler with simple and intuitive interface. Moreover, you can convert markdown documents to HTML with the click of a button!. If you want to contribute to the developement of this addon, please fork it on GitHub, and push your changes to a named branch. Moreover, you can review all the comments made on GitHub commits.
5 Reasons to Use Markdown Editor
Allows you to view edit markdown code right in your browser.
Can convert markdown documents to HTML5 and PDF.
Can drag and drop or open .md documents via file selector UI.
Available for Chrome, Opera and Firefox browsers on all operating systems.
This video gives you an idea of how the extension works in your browser.
Frequently Asked Questions
1. What is Markdown Editor?
2. How can I work with this addon?
Working with markdown editor addon is very easy. Simply open a .md file or drag and drop the file to the app UI. Alternatively, you can copy and paste the code in the editor area or right your own from scratch. Once editing the code is done, please click on the compile button to convert the markdown code to an HTML5 document. Please note that, as you type the code this addon compiles the markdown document to HMTL on-the-fly. So, there is no need to press on the compile button each time you edit the code. Only press on the compile button if you want to re-compile the code or you see any errors in the final result. The compiled document (HTML) is then rendered in the app UI, right section. If the app window is small, the rendered document will be at the bottom section (app UI is responsive). At any time, you can click on the PDF button to open the print window. If you have a pdf writer in the printer list, you can click on that to convert the HTML5 document to PDF. Next time when you click on the PDF button, the pdf printer will be set as the default option, so you dont need to re-select that again. As mentioned above, there are few settings available for the app on the top toolbar. Simply mark each option and see the result right away. Options are self-explanatory and if you hover the mouse on each button, a tooltip text will be shown, explaining the functionality of the button. A sample code is also included in the app. When you open the app for the first time, the sample markdown code will be loaded in the editor area (left section of the UI). Please read the sample code to get an idea of the commands that the markdown compiler can process.
3. How can I download the source code for Markdown Editor?
To download the source code for this extension from Chrome Web Store, it is recommended to use Extension Source Downloader. With this addon, you can download the source code as a ZIP or CRX format to your machine. If you want to download the source code from the Firefox addons store, please open the firefox download link (if available) in the Firefox browser and then right-click on the - Add to Firefox - button and select - Save Link As... - item. Choose the destination folder on your machine and then save the file in XPI format. You can then rename the XPI format to a RAR or ZIP file. Some extensions may have a GitHub repo address, which you can use to download the source code as well. But, it may not be the latest version of the addon. Therefore, downloading the source code from the official web stores is the best option as it always gives you the latest version of the addon.
4. Does this app work similar to the native markdown applications?
5. What options are available in Markdown Editor?
In the top toolbar there are few settings related to markdown compiler. Each option has a tooltip text explaining the functionality of it. When you change each setting, the markdown document will update the result so you can see the final HTML5 document on-the-fly as you change options. Please note that all settings are auto-saved to the memory so there is no need to do any further actions to save the settings.
6. What API/engine is behind this markdown editor?
7. How can I reload the app?
On top right corner in the app UI, there is a reload button. Please press on this button if you want to reload the app, or in case something goes wrong within the app UI. Please note that the editor automatically restores the last opened document whenever the UI is opened or reloaded.
8. Is this app available for mobile browsers?
Yes, this app can be used in both mobile and desktop machines. It can be used in all browsers and platforms including mobiles and tablets as long as a modern browser with addon capabilities is installed.
9. Can I use a different engine other than markdown-it or codemirror in this app?
No, currently this app is only working with the default engines. There is no option to change or alter the APIs in the current version. Support for this feature may be added in future versions.
10. How can I disable this addon?
When this addon is closed, it is inactive by default. But if you want to permanently disable the addon, please open the extensions tab in your browser and then click on the disable button.
Your feedback goes a long way towards making this addon even better. With this bug report form, you can submit bugs or suggest enhancements for the functionality or performance of this addon. Please note, this bug report form will be sent to the developer(s) of this addon. You will not get an immediate or personal response at the moment. However, the developer(s) may contact you through the email address provided in this form for further clarifications or requesting additional information regarding the reported bug(s).
Reviews | Discussions
Please note: keep these reviews/discussions clean, and avoid the usage of derogatory or inappropriate language or terminology in references to individuals or groups based on race, national or ethnic origin, color, religion, age, gender, etc. Do not submit bugs in your reviews, use the above bug-report section instead. Also, never post any personal information in these reviews.
GitHub Issues | Fork me on GitHub