Convert readme to markdown #302
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I don't mind. If everything stays the same (I think I saw broken doc from markdown somewhere once), I actually prefer this. |
|
Me too @lencioni Can you please squash your commits into one? |
This started as a straight up automated conversion via pandoc: pandoc README.textile -o README.md I then followed up by fixing the images it did not convert properly, removing extraneous backslashes that it added, and adding finced code blocks for syntax highlighting. I also replaced <code>...</code> with backticks and adjusted some whitespace.
|
Sqauashed! |
|
Great, thanks! |
iainbeeston
added a commit
that referenced
this pull request
Feb 17, 2016
Convert readme to markdown
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
More people are more familiar with this format, and other documents in this repo are in markdown so it seems like a good reason to switch. Additionally, we can get syntax highlighting on github by using fenced code blocks in markdown, which I added in this PR. Rubydoc.info can also handle GitHub flavored markdown now, so everyone wins!