documentation icon indicating copy to clipboard operation
documentation copied to clipboard

How to configure MarkdownBear

Open plaindocs opened this issue 9 years ago • 9 comments
trafficstars

It really isn't clear how to configure bears. I'm trying to configure the MarkdownBear, which is a remark thing, but while remark picks up a .remarkrc coala just wipes the files if I try to use it.

plaindocs avatar Oct 31 '16 11:10 plaindocs

True. Are there auto generated docs for each bear ?

@plaindocs Until then if you do coala --show-details --show-bears --no-config -b PEP8Bear this would give you information about the configs and other things about the bear

AbdealiLoKo avatar Nov 01 '16 04:11 AbdealiLoKo

Right, that shows me what options are available, but not actually how to use them. I dug around a bit in the remark docs, and it wasn't quite gelling.

I had a valid .remarkrc file which remark was picking up but coala was just wiping the file.

plaindocs avatar Nov 01 '16 19:11 plaindocs

coala is wiping the file? This shouldn't happen actually. Maybe remark does it itself?

About using the settings: You are aware of our .coafile which is our main configuration file? You just specify the setting there:

bears = MarkdownBear
markdown_fences = yes
# ...

Makman2 avatar Nov 02 '16 11:11 Makman2

haha, omg, I was not aware that you'd integrated the settings in the .coafile, I thought they were remark settings only. I'll make a PR for the MarkdownBear README.

plaindocs avatar Nov 02 '16 12:11 plaindocs

Looks like the https://github.com/coala/bear-docs/blob/master/docs/MarkdownBear.rst is generated? Is there anywhere I can add free text?

plaindocs avatar Nov 02 '16 16:11 plaindocs

@plaindocs add it at the coala-bears repository directly in the bear, the docs are generated from the documentation comment.

sils avatar Nov 02 '16 17:11 sils

@plaindocs if you have any feedback for us, including what we just discussed about, you can fill it in at coala.io/usability - we'll definitely look at it.

sils avatar Nov 02 '16 17:11 sils

Great. We're meeting on Saturday in Berlin anyway I think. :-)

plaindocs avatar Nov 02 '16 18:11 plaindocs

Ah nice, seeing forward to meet you on 12th then!

sils avatar Nov 02 '16 18:11 sils