convert md to html during publication of /sub/

[marc-portier]

at least the various /OSD{YYYY}/README.md should be made available as html but it might be just more straightforward to convert any */md to html

[RoryMMMM]

Some things need to be decided (that might have implications down/upstream) before work can continue on this.

My current thinking is that the readme.md > readme.html function can be combined with the header/footer function. That way a gh-page is created that has some consistent styling, has the readme on the front-page and a link to the preview.html (or other way around).

The questions are:

• where does the styling file come from? Jekyll has a template file and we can use the same idea here.
• The template file has to be available to the project so that gives us two options:
  • Put the template file into the crate repo. This would mean sticking non rocrate files into a rocrate repository.
  • Put the template file into another repo in the organisation. This would mean that the repo be available/public so automated pulls can work and all org-projects would then share a style.
• If we're going into full Jekyll publishing mode then we should probably rewrite some of the action to do the following:
  • clone repo files
  • clone template repo file
  • create preview.html file from rocrate.json file
  • using jekyll combine template, readme file, and preview.html file into a single set of static web files
  • publish

[RoryMMMM]

I think jekyll already does this:

https://data.ocean-sampling-day.org/urispace

Also Cedric's tool also does this. Marking as closed.