chharvey
commented
9 years ago Pros and Cons for GitHub-Flavored Markdown vs Jade
| GFM | Jade | |
|---|---|---|
| Pros | - pretty on GitHub - source concise - no compile necessary - no server access needed | - pretty on site - more control over html/css - variety of elements - allow js/mathjax - server access if allowed |
| Cons | - plaintext on live site - no control of css - no js/mathjax - not as many html elements | no view on GitHub - compile before pushing - source is verbose |
| Verdict | use GFM for drafts, api/documentation where styles/scripts are not that important | use Jade for articles, documents, blogs, lesson pages, etc. |
Now, use GFM directly in Repo or on Wiki?
| Repo | Wiki | ||
|---|---|---|---|
| Pros | - same repository / commit history (if wanted) - possible filetree structure - create links to pages | - collaborate with public - different repository / commit history (if wanted) | |
| Cons | - pushed to site as plaintext - included in package (if not wanted, but just use [npm | git]ignore) | - no filetree structure - not available in package (if wanted) |
| Verdict | :white_check_mark: | :x: |
Use jade instead of html for all blog and page source. For now, compile locally then upload, but later find a way to do this on the server?
Helps the closure of #9 because Jade has a template system. Also helps any issue tagged
layer-HTML, especially #40 and #22Pages to convert: