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

sustaining/best-practices: some small ideas & additions #61

Merged
merged 1 commit into from
Sep 6, 2016
Merged

sustaining/best-practices: some small ideas & additions #61

merged 1 commit into from
Sep 6, 2016

Conversation

jessfraz
Copy link
Contributor

part of #54

I'm a terrible writer so I'm sure this isn't as well worded as someone else could do but I had a couple things I thought might be nice to be added.

Also as a meta thought, have you thought about some sort of markdown fmt-er haha because my vim kinda made the paragraph have line breaks.

@bkeepers
Copy link

bkeepers commented Aug 20, 2016

@nayafia is the wordsmith, so I'll leave this for her to review and merge (she's on vacation next week).

Also as a meta thought, have you thought about some sort of markdown fmt-er haha because my vim kinda made the paragraph have line breaks.

It looks like remark-lint doesn't support this (yet).

Know of a tool that does? /cc @wooorm

@wooorm
Copy link
Contributor

wooorm commented Aug 20, 2016

remark-lint doesn’t have fixes yet, no, which is a bummer. I’m not entirely sure how to do that yet.

There is remark -o though, which compiles markdown (so it can be used like a fmt’er).
It works really well in my opinion, but on the other hand It’s pretty strict in it’s style though. Here’s the list of available settings.

(edit: clear language)

@wooorm
Copy link
Contributor

wooorm commented Aug 20, 2016

Oh it’s not needed to use the remark CLI btw: at this point the files are already formatted, just like how the CLI does it!

@nayafia nayafia merged commit 7eff3ca into github:gh-pages Sep 6, 2016
@nayafia
Copy link
Contributor

nayafia commented Sep 6, 2016

Thanks for these suggestions!

@jessfraz jessfraz deleted the best-practices-mods branch September 6, 2016 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants