Categories: Software Development

PyCharm: Markdown mode can display a Preview

The PyCharm markdown mode can display a preview! PyCharm is an IDE based on the popular IntelliJ IDE, it is specifically designed for working with Python. On most projects, Markdown is the popular text format that is used. It can be helpful to see a preview of the Markdown text that you are writing before committing it to your code repository or wiki.

If you need more reasons to try PyCharm, check out my presentation “Why PyCharm?”

It’s something that will help me document projects. Sometimes I wonder how the README of a project will look on github or bitbucket and the only way for me to check is to push my changes, fire up the browser, go to the repo and check it out. If there’s a mistake, then I have to do another commit, reload the browser and see what happens.

Text mode:

Text view of markdown in PyCharm
Text view of markdown in PyCharm

Preview mode:

Preview of a markdown file in PyCharm
Preview of a markdown file in PyCharm