Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TODO is probably not up to date #48

Closed
dumblob opened this issue Sep 26, 2015 · 4 comments
Closed

TODO is probably not up to date #48

dumblob opened this issue Sep 26, 2015 · 4 comments

Comments

@dumblob
Copy link

dumblob commented Sep 26, 2015

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
Copy link
Owner

hplgit commented Sep 27, 2015

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
Copy link
Author

dumblob commented Sep 27, 2015

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 hplgit closed this as completed Oct 3, 2015
@hplgit hplgit reopened this Oct 3, 2015
@hplgit
Copy link
Owner

hplgit commented Oct 4, 2015

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
Copy link
Author

dumblob commented Oct 4, 2015

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)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants