Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix code snippet in README #40

Closed
samWson opened this issue Aug 4, 2018 · 2 comments
Closed

Fix code snippet in README #40

samWson opened this issue Aug 4, 2018 · 2 comments

Comments

@samWson
Copy link
Contributor

samWson commented Aug 4, 2018

There is something odd about how the code snippets are being rendered in the README. However looking at the markdown code it appears to be fine.

badly-rendered-markdown

When I have a look at the same file in MacDown on my computer, the code snippets are rendered and displayed correctly. Maybe there is some small quirk with how Github renders markdown?

@macta
Copy link
Contributor

macta commented Aug 4, 2018

Yeah it's weird - the markdown is supposed to imply that the code and paragraphs are indented under the 2nd list item - but its not doing that.

It seems like it doesn't like the indented formatting, so I just removed it for now - but I do think we could do with a formatting pass on the docs in general, so will leave it open for now.

@samWson
Copy link
Contributor Author

samWson commented Feb 22, 2019

Closing this. Not relevant anymore.

@samWson samWson closed this as completed Feb 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants