API - Configuration

[bebraw]

Stub.

Feel free to comment here if you have ideas on what this guide should cover. Link to potential resources too.

This is to stub and rewrite the existing page

[skipjack]

Can I take a stab at this one? I already started playing around with this when I was doing the documentation mockup. Might need a some advice on certain sections but at this point I'm familiar with and have used most of the configuration options...

[bebraw]

Sure, that would be great.

[skipjack]

Ok great, I'll start this week.

[skipjack]

@bebraw while working on this section, I noticed that our markdown parser doesn't accept:

... [link][1] ...

[1]: http://example.com

Is this intentional? I find this feature super helpful when adding long external links... it doesn't bother me as much to inline the in-site links.

[bebraw]

Yeah. Footnotes aren't a good idea on the web. Hard to lay out, bad UX. It's better to use T> and W> for secondary information.

[skipjack]

I don't mean actually having the links at the bottom of the page, I just mean separating out long links to make the markdown more readable. What the user sees is unchanged by this, i.e. [link][1] and [link](http://example.com/path/to/my/page) yield the same result when used in markdown but the first makes paragraphs containing multiple links much easier to read and edit.

[bebraw]

Ah, like that. If marked doesn't support that syntax by default, then you'll probably need a syntax extension for that purpose.