Infusion Documentation Conventions

Bates, Simon sbates at ocadu.ca
Mon May 5 15:44:25 EDT 2014


Hi all,

Antranig, Anastasia, Justin, and myself met this afternoon regarding our work on the Infusion 1.5 documentation [http://wiki.fluidproject.org/display/fluid/Infusion+Documentation+Plan]. During our discussions a couple of topics came up that I wanted to share:

* what dialect of Markdown should we use?
    * we are thinking that we will start with GitHub Flavored Markdown (GFM) https://help.github.com/articles/github-flavored-markdown
* what naming convention should we use for files?
    * we will use UpperCamelCase.md

We are thinking that it is reasonable to start with GitHub Flavored Markdown as GitHub is our initial target hosting environment. In practice, this will be the implementation that we use.

In the longer term, GFM seems reasonably widely supported in other use cases also. For example, there is a JavaScript Markdown processor called "marked" that supports GFM [https://github.com/chjj/marked]. And there's a marked plugin for DocPad.

Simon


More information about the fluid-work mailing list