[SciPy-Dev] Migrating to Markdown Syntax from reStructured Text in SPC

[Surya Kasturi]

Hi all, its just an idea and appreciate your comments.

I am thinking about migrating text markup that spc currently supports from
reStructured Text to Markdown..

Reasons:

1. reST has some security issues - Someone can put some raw HTML in it and
thus creating vulnerabilities.. Better explained at

https://docs.djangoproject.com/en/1.4/ref/contrib/markup/#restructured-text

2. currently reST to HTML conversion is done on the server side! It could
be done on client side enabling better text editing and previewing..

Markdown seems to be a decent option since there are some opensource tools
(by Stackoverflow) and we can start integrating them with our site

http://code.google.com/p/pagedown/wiki/PageDown
(link previously referred by Sebastian during discussion - thanks!)


Eventhough we might not move to Markdown, there seems to be some tools
django offers for handling text markup

https://docs.djangoproject.com/en/1.4/ref/contrib/markup/

And we dont have to use convert_rest_to_html() at all!!
Probably, we might need to convert everytime the user loads the page (have
to look into the exact docs.. don't know) but it offers us another feature

Rightnow, the image uploads embedded in description as hardcoded during
conversion i.e., the URL looks something like "
scipy-central.org/media/blah-blah/122.jpg" If for some reasons we change
the domain name or want to work on localhost, these images don't work!

https://github.com/scipy/SciPyCentral/issues/123



It would be nice to have your views.. its not part of GSoC but probably, we
can put it in..or if I got some extra time, I can do without mentioning in
GSoC proposal.

Thanks
Surya
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/scipy-dev/attachments/20130704/9a099be6/attachment.html>