search

datacarpentry / lesson-template-ARCHIVED

This is a repository that is a template for lessons
http://datacarpentry.github.io/lesson-template
Other
7 stars 14 forks source link

Rmd versus md versus html #29

Open lexnederbragt opened 7 years ago

lexnederbragt commented 7 years ago

CONTRIBUTING.md states

Lessons may be written in Markdown, as IPython Notebooks, or in other formats. However, as explained in the README file, Jekyll (the tool GitHub uses to create websites) only knows how to handle Markdown and HTML. if some other format is used, the author of the lesson must add the generated Markdown to the repository.

I interpret this as "if you want to submit a PR, submit it to the markdown or Rmarkdown file, not the html file."

The (new) R-Genomics lesson has an index.md, index.rmd and index.html. It is unclear which file to edit for a PR.

Solutions: either

By the way, "as explained in the README file": the README file has no such explanation.

tracykteal commented 7 years ago

For R-Genomics the file to edit is index.Rmd. index.html is being rendered via the Makefile. index.md is deprecated in the move to this template.

tracykteal commented 7 years ago

@lexnederbragt we're just trying this template. What do you think?

lexnederbragt commented 7 years ago

I like it, with the floating TOC and all. But, I miss the 'solution is hidden within the exercise box' from the current SWC template.

lexnederbragt commented 7 years ago

See https://github.com/data-lessons/R-genomics/issues/16, which is what caused the confusion today.