Python files (or any other programming scripts) with rendered markdown in comment blocks

Alright, I’ll take python as an example as it has the closest equivalent already existing.

I think it would be incredible if it was possible to write more lengthy documentation in a regular code script comment block, and have it properly render with wikilinks and all the obsidian goodness we are getting accustomed to.

The closest equivalent nowadays is the .ipython standard, but it approaches the problem from the opposite angle, which works for data science, but is less useful for more complex code.

This would look as follows:



More advanced [[doc]]


(Not sure if possible but going a step further and not requiring the markdown flag would be even nicer)

This wouldn’t impact the usability of python files in any other settings, but would allow for a pretty insane documentation workflow.

Additionally it would allow for writing documentation using ai assistance such as GitHub copilot in any other advanced IDE while still being browsable in obsidian.

I wouldnt have the ability to do this myself, but if any wizard is up to tackle that it would be nothing short of revolutionary for programmers like myself!


1 Like