[ocaml-infra] Redesigning OCaml.org - Using Markdown

Maxence Guesdon maxence.guesdon at inria.fr
Thu Jul 4 10:14:24 BST 2013


On Thu, 4 Jul 2013 09:54:57 +0100
Amir Chaudhry <amc79 at cam.ac.uk> wrote:

> # Redesigning OCaml.org
> 
> Some time ago, I mentioned that we would be looking over the design and
> structure of the OCaml.org website [1] and integrating the improvements we've
> begun in the OCaml ecosystem, including OCamlot and the documentation work
> (see the OCaml Labs news updates to catch-up on everything [2]).  
> This message is a summary of the thinking so far and input is welcome.
> 
> One of the specific things we've been thinking about is generating pages from
> Markdown files, instead of html.  This would make writing content a lot 
> easier for contributors and makes maintenance more straightforward.  Of 
> course, not every page would be markdown-based and for some it makes sense 
> to stick with html (e.g the landing page).  Making a transition like this 
> would involve examining the current toolchain and creating new libraries where 
> appropriate, but these should be beneficial to the OCamlers in general 
> (e.g a good Markdown library).  Below are the broad areas that I think we 
> need to consider (but please let me know if I've missed something!)

FWIW, Stog has a markdown plugin developped by Gabriel Scherer,
allowing the use of markdown instead of xml for (part of) the contents
of a page:
  https://github.com/zoggy/stog/blob/master/plugins/stog_markdown.ml

Regards,

Maxence


More information about the Infrastructure mailing list