dwyl / dwyl/start-here

Review Github Flavoured Markdown & determine where it will break our readmes

Open
#136 1 comment 6 reactions 0 assignees View on GitHub
help wanted priority-3 starter
Dominant language
No language data
Stars
1.9k
Forks
110
PR merge metrics
No merged PRs in 30d

Description

As @newswim kindly pointed out in https://github.com/dwyl/technology-stack/issues/54, Github is now rolling out [Github Flavoured Markdown](https://github.github.com/gfm/) (or GFM).

Our learning community relies heavily on readme's and as has been pointed out before, the formatting of these readme's lends us our [quirky conversational style](https://github.com/dwyl/start-here/issues/118#issuecomment-279115518).

**Task:** Review the GFM spec for the most commonly used markdown in dwyl and determine what is likely to break (we can then look to write a script to fix this across the board separately).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.