The documentation preview html is broken..

[dhrp]

Edit:
Hmmm. It appears this is intended. Sorry then for creating this issue. Instead perhaps take it as an opinion "it looks broken".

I really like the concept though.

[dkisselev]

See #25

That's intended, the sample docs just don't have enough text to go with the code so it doesn't look right. (#25 has some other examples that look better)

[dhrp]

Yeah, just saw it. Sorry! -- was updated the issue while you closed it.

[dkisselev]

No worries. I try to spam a link back to issue 25 as much as I can because this tends to come up a lot. (I should really get around to adding better sample docs, but I'll be overhauling the default samples when 1.0 comes out, so it's a pretty low priority for now)

[dhrp]

Adding text just to make documentation look ok is not a very sustainable thing to do. If I'd be creating some very example heavy documentation, would I be forced to add a bunch of lorem ipsum? Or use something other than daux.io perhaps?

Perhaps at least removing the indenting/outdenting (jitter) would help. Also some hinting of where the code block starts and ends would be good, for example a line on top and bottom of a code block. So at least the code look to be 'in the right place'.

On Nov 12, 2013, at 12:48 PM, Denis Kisselev wrote:

No worries. I try to spam a link back to issue 25 as much as I can because this tends to come up a lot. (I should really get around to adding better sample docs, but I'll be overhauling the default samples when 1.0 comes out, so it's a pretty low priority for now)

—
Reply to this email directly or view it on GitHub.

[dkisselev]

There is a config option called Code floating that disables this feature for example-heavy docs.

The jitter is actually meant to act as the code hinting that you're referring to. In #25, geebru's reply/image shows how it looks with more content, it shows the start and end of each markdown code block.