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

[Thomas Gazagnaire]

> > And about the wiki?
> 
> One idea we've considered is having an "edit" link on every page, which would go directly to the github url for the source of that page. Then, GitHub allows you to edit the file directly in your browser. If you are not authorized to edit the main repo, GitHub will initiate a fork.
> 
> Using GitHub's separate wiki feature is also an option, but I'm not sure it helps above having markdown in the main repo.

FWI, it's the design we went for OPAM documentation: pages in http://opam.ocamlpro.com/doc/ are automatically generated from https://github.com/OCamlPro/opam/wiki

We are using CoW to do the Github Markdown parsing, and we automatically generate the table of contents, etc. It's far more easier than having to maintain a proper wiki, with all the authorization mechanism complications.

--
Thomas

> 
> In both cases, the assumption is that converting the current HTML sources to Markdown will ease contributions. Thus, we need to get through the conversion, and then we can figure out how to optimize the contributor experience.
> 
> 
> On Thu, Jul 4, 2013 at 7:13 PM, Florent Monnier <monnier.florent at gmail.com> wrote:
> 2013/07/04, Amir Chaudhry wrote:
> > # Redesigning OCaml.org
> [...]
> > One of the specific things we've been thinking about is generating pages
> > from Markdown files, instead of html.
> [...]
> 
> And about the wiki?
> If nothing is done yet I was thinking that Github's wiki could be
> used. It uses markdown so some content could then be easily transfered
> to and/or from the statically generated website.
> 
> --
> A+
> _______________________________________________
> Infrastructure mailing list
> Infrastructure at lists.ocaml.org
> http://lists.ocaml.org/listinfo/infrastructure
> 
> _______________________________________________
> Infrastructure mailing list
> Infrastructure at lists.ocaml.org
> http://lists.ocaml.org/listinfo/infrastructure