search

monarch-initiative / phenogrid

The phenogrid widget
13 stars 14 forks source link

Fixes gulp workflow and index.html so that README.md is the authorita… #101

Closed DoctorBud closed 9 years ago

DoctorBud commented 9 years ago

Fixes gulp workflow and index.html so that README.md is the authoritative documentation, and that it is rendered into the example index.html, which is generated from templates/index.html via the gulp-include-plugin.

Updated the README to eliminate mention of jQuery. Clients should not have to know about jQuery; it is a currently implementation detail that no longer leaks out of the Phenogrid abstraction.

Deletes jsdoc usage. The README.md should be sufficient unless we have a richer API to expose (currently we expose a single function).

Also adds GFM CSS for use in the generated index.html. (Hopefully this will not intrude on Phenogrid's CSS; so far, it looks OK).

Moves the inlined print CSS into a separate file, but disables it until I understand why this was done in the first place. If we reenable it and there are good reasons for not using LINK and instead inlining it, I have prepped it to use the gulp-include-plugin.

yuanzhou commented 9 years ago

Thanks Dan!

If I would have knew marked.js earlier, I would never want to compose the index.html manually and keep it updated with the readme.md. This saved my time a lot! FYI, I used http://pygments.org/ for the syntax highlight.

No worries about gfm.css, all of the gfm styles are scoped to .markdown-body, it won't cause any conflicts with phenogrid.css. One thing I noticed that is the gfm.css is linked inside the HTML body tag, which is an invalid usage. <link> is allowed in body tag, but we will need to do it a little differently to make it HTML5 valid:

<link rel="stylesheet" property="stylesheet" href="node_modules/gfm.css/gfm.css">

I'll change this right after I merge this PR.

Inline CSS used for printers (media @print)was put in the beginning of the index.html just because I copied it from potatoguide (one of my personal projects, potatoguide.com) when I started to hand compose that index.html. It's my HTML style that I tend to consider the printers for each HTML page. As far as I know, the order doesn't matter. It seems we won't need to use any printing styles since the index.html is very simple.