I would like to create markdown documentation for a library in github. However as I have no way to preview what I am doing, it is common to make errors that are only discovered when the file is already published. Are there any tools where you can view the edits I'm making in .md files in real time?
how to preview .md file during editing?
4
asked by anonymous 30.11.2015 / 09:40
2 answers
2
You can do this online using this site or use one of the packages that already comes with atom , called markdown-preview . To access the view of what is being edited, you only need to have the selected tab in one of the following file types:
- .markdown
- .md
- .mdown
- .mkd
- .mkdown
- .ron
- .txt
And in the main menu of the atom select the following:
Or simply press at the same time:
ctrl-shift-m
An example can be seen here:
30.11.2015 / 09:40
1
There's also a plugin for Google Chrome called MarkViewer , very good and simple. Just open the file in the browser (with the plugin installed) that it already recognizes and formats. It is not necessary to keep updating the page with each file change, the browser already detects the changes and updates automatically.
Plugin site: link
30.11.2015 / 11:56