On Fri, Apr 24, 2015 at 6:16 AM, Powerman <[email protected]> wrote:

> That one is mostly of interest for asciidoc/asciidoctor developers,
> who may like to fix/discuss these issues.
>

Thanks Alex. This is certainly useful.

Before I start, I want to mention that you should add the following to the
header of your document so that it works consistently once the 1.5.2
upgrade happens on GitHub.

:compat-mode:

(for details, see http://asciidoctor.org/docs/migration/)

I'll address a few items I see in comments:

> Line with unknown attribute must be removed, but it's not.

This is controlled by a document-level setting in Asciidoctor. We consider
it dangerous to drop lines by default, so we've made the default to show
the missing attribute instead. If you want to restore the old behavior, you
set:

:attribute-undefined: drop-line

You can also set a value of "skip", "warn" or "drop". For more info, see
http://asciidoctor.org/docs/user-manual/#catch-a-missing-or-undefined-attribute

> In GitHub Wiki table of contents looks worse than in file, especially
multi-level one, because it include list bullets.

GitHub recently fixed this problem in GitHub repositories, so I expect that
the CSS will get propagated eventually. The codebase on GitHub is not in
sync between repositories, wikis and gists, which is frustrating and the
source of bugs. But that is something outside the scope of AsciiDoc support.

> Paragraph title is not highlighted.

We're exploring a solution to this problem by using <strong> around the
title. GitHub takes away all CSS information from the generated HTML, so we
have to use elements to maintain styles in certain cases.

The same is true for example blocks and sidebars. By switching the HTML5
elements like <aside>, we might be able to get some level of styling. But
we can't use CSS, unfortunately. That would require some negotiation with
GitHub folks. I'm still hopeful.

> Type of block (NOTE/TIP/…) should be shown as an icon, not as text.

This is also the CSS problem. However, I do have a proposed fix that might
allow us to use GitHub's icon set. See
https://github.com/jch/html-pipeline/pull/61 (we'd need to port this to
https://github.com/asciidoctor/html-pipeline-asciidoc_filter).

> Example caption removed, not changed.

Caption isn't used unless the block has a title. I don't know why this
works in AsciiDoc Python, but I consider it to be unspecified behavior.

> include\:\: is replaced with link:

This enables navigation to files on GitHub as a concession for includes not
being allowed. I'm still pushing to get includes enabled, but it requires a
lot of sweet talking.

It does leave behind raw links when in verbatim blocks, but this is just a
caveat of AsciiDoc parsing.

> Ordered list markers differs from AsciiDoc

I don't know why GitHub is missing nested list styles. This seems to be a
serious bug in GitHub styles, which of course affects us.

>  Table (a lot of things) doesn't work

Again, due to the HTML sanitizer. We have no way to control table layout if
all the style information is stripped. We just get very plain tables.


There are things that we can fix, but AsciiDoc on GitHub is always going to
look a bit plain because they want documents to look this way. That's one
of the reasons we've developed an alternate viewer frontend for GitHub (and
DropBox) named docgist.

You can see your document rendered in it's full glory.

Full::

http://gist.asciidoctor.org/?github-powerman%2Fasciidoc-cheatsheet%2F%2Ffull.adoc

Basic::

http://gist.asciidoctor.org/?github-powerman%2Fasciidoc-cheatsheet%2F%2FREADME.adoc

-Dan

-- 
Dan Allen | http://google.com/profiles/dan.j.allen

-- 
You received this message because you are subscribed to the Google Groups 
"asciidoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/asciidoc.
For more options, visit https://groups.google.com/d/optout.

Reply via email to