[ocaml-infra] markdown in "pure" OCaml

Amir Chaudhry amc79 at cam.ac.uk
Thu Aug 8 13:14:08 BST 2013


On 7 Aug 2013, at 20:18, Philippe Wang <philippe.wang at cl.cam.ac.uk> wrote:

> 
> On 7 Aug 2013, at 14:50, Christophe TROESTLER <Christophe.Troestler at umons.ac.be> wrote:
> 
>> On Wed, 7 Aug 2013 13:58:16 +0100, Philippe Wang wrote:
>>> 
>>> Lately I realised that there are actually two markdown render engines
>>> on github: the one that is officially "GFM" (github flavoured
>>> markdown), which is used for issues, comments and pull requests, and
>>> the other one, which is somehow closer to standard markdown, that is
>>> used to render .md files in repos when you click on them (e.g., any
>>> .md file in https://github.com/pw374/sandbox/).
>>> 
>>> So I've decided that by default, omd should do standard markdown
>>> newlines, not GFM's.
>>> 
>>>>> [gfm_newlines]:
>>>>> https://help.github.com/articles/github-flavored-markdown#newlines
>> 
>> I think this is a good decision.  Line breaks should not be enforced
>> for HTML paragraphs as these need to resize well according to the
>> browser width, font size,...  Moreover, since links will take more
>> space in Markdown than in HTML, it would be cumbersome to format
>> paragraphs well if newlines were transformed into <br/>.
> 
> Indeed.
> 
>> While I am at it, I remember that "extension points" were evoked.
>> They are required IMHO if one wants to attach some code to the
>> transformation Markdown → HTML.  For example, if one wants to have a
>> paragraph or a block of code initially hidden (with a button to make
>> it visible).  Is there any design for this ATM?
> 
> At this moment (it took me a while to figure out what ATM meant), 
> there is no design for what you mention.

Christophe, is your example referring to things like the 99 problems page [1, 2], where there are problems posed and clicking a button reveals the solution.  I'm not clear why this would be relevant to the Markdown implementation as html in the markdown file should be fine.  

Am I missing something?

[1] page: http://ocaml.org/tutorials/99problems.html
[2] source: https://github.com/ocaml/ocaml.org/blob/master/src/html/tutorials/99problems.html

Amir


More information about the Infrastructure mailing list