search

hplgit / doconce

Lightweight markup language - document once, include anywhere
http://hplgit.github.io/doconce/doc/web/index.html
Other
311 stars 60 forks source link

TODO is probably not up to date #48

Closed dumblob closed 8 years ago

dumblob commented 8 years ago

I've tried to get a whole picture about this project by reading different docs etc. and stumbled upon TODO. I wonder if it's still up to date as the mentions of pandoc etc. doesn't make me feel like so.

Particularly I'm looking for a better support for CommonMark with some extensions (as described on https://github.com/jgm/CommonMark/wiki/Proposed-Extensions-to-CommonMark) allowing the same set of features as the markup used e.g. for the book A Primer on Scientific Programming with Python (I believe the markup is the one on http://hplgit.github.io/teamods/writing_reports/_static/report.do.txt.html).

hplgit commented 8 years ago

TODO is definitely very outdated. I have updated it now. It's a very unofficial todo list hidden in a "hidden" directory .TODO that starts with a dot...

DocOnce-generated Markdown does not yet consider the rules of CommonMark, but seems very close to. The proposed extensions to CommonMark will make it much easier to translate many DocOnce elements that don't have a counterpart in standard Markdown.

dumblob commented 8 years ago

Thanks for the TODO update and explanation where the project is heading. I like the direction.

The proposed extensions to CommonMark will make it much easier to translate many DocOnce elements that don't have a counterpart in standard Markdown.

Did you mean both-way translation? I.e. from CommanMark with extensions to DocOnce and vice versa?

hplgit commented 8 years ago

It would be nice to have a two-way translation, but the challenge is to store the richer set of constructions in DocOnce in CommonMark code. Actually, we have already done something close in the two-way translation between DocOnce and IPython/Jupyter notebooks: DocOnce constructions not present in notebook Markdown are stored in comments. With the proposed extensions to CommonMark most of the DocOnce elements have a counterpart in Markdown.

dumblob commented 8 years ago

Great news, thanks @hplgit . I'm closing this issue as it was about TODO. Should I open a new issue for the two-way translation (DocOnce <=> CommonMark with extensions)?