enable markdown syntax highlighting in code comments/docs

Question

There are great in-code documentation standards for python, for example:

Google
Numpy

Which use some nice, simple ReStructured / Markdown like syntax. Is there a way to have emacs render ReST / Md inside the comments of python code? I.e. the major-mode would still be python.el, and normal python syntax would work; but inside a comment block ('''...''' ) it would be rendered as some sort of markdown.

homeless · Accepted Answer · 2015-02-14 12:08:40Z

1

You should be able to achieve this by using the polymode package (https://github.com/vspinu/polymode). It allows you to have multiple major modes in one buffer. Have a look at the screenshot examples.

There are other packages too which can enable multiple major modes in one file: http://www.emacswiki.org/emacs/MultipleModes

edited Feb 14, 2015 at 12:08

answered Feb 13, 2015 at 22:10

homeless

3361 silver badge8 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

enable markdown syntax highlighting in code comments/docs

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related