You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I'm not sure how feasible this is, but it'd be really nice if one could do ordered lists across blocks of code in Docco. Currently if you do:
// 1. Foo
// 2. Bar
Markdown correctly translates that in to:
1. Foo
2. Bar
(formatted as an ordered list). However, if you try to mix code in:
// 1. Foo
var foo = 1;
// 2. Bar
var bar = 2;
you will get the code on the right, and on the left you'll see:
1. Foo
1. Bar
this makes sense in Markdown terms because if you do regular Markdown of:
1. Foo
anything else
2. Bar
Markdown will consider that to be two separate lists, not one list broken up.
However, what that translates to in Docco terms is that one can never use a decimal point-based list to spell out steps. You can't use hashes either, eg.:
#1 Do X
#2 Do Y
because that gets formatted as a header. So the only option I can see for doing lists in Docco is to use a parenthesis:
1)
2)
and since that just produces <p> tags it's difficult to style such a list.
While I realize that this might be difficult to implement (since Docco relies on Markdown), lists are a very useful thing to have when creating documentation, so please consider providing some sort of solution for them.
The text was updated successfully, but these errors were encountered:
Because Docco calls marked once per block of documentation, rather than once per file each new document block is treated as its own markdown document. This should be fixed, it is actually a regression because this used to work.
The bug is actually a dupe of #268. Please follow that issue for updates.
I'm not sure how feasible this is, but it'd be really nice if one could do ordered lists across blocks of code in Docco. Currently if you do:
Markdown correctly translates that in to:
(formatted as an ordered list). However, if you try to mix code in:
you will get the code on the right, and on the left you'll see:
this makes sense in Markdown terms because if you do regular Markdown of:
Markdown will consider that to be two separate lists, not one list broken up.
However, what that translates to in Docco terms is that one can never use a decimal point-based list to spell out steps. You can't use hashes either, eg.:
because that gets formatted as a header. So the only option I can see for doing lists in Docco is to use a parenthesis:
and since that just produces
<p>
tags it's difficult to style such a list.While I realize that this might be difficult to implement (since Docco relies on Markdown), lists are a very useful thing to have when creating documentation, so please consider providing some sort of solution for them.
The text was updated successfully, but these errors were encountered: