danielgtaylor / aglio

An API Blueprint renderer with theme support that outputs static HTML
4.75k stars 481 forks source link

HTML in headers rendered inconsistently #159

Closed winniehell closed 9 years ago

winniehell commented 9 years ago

Using aglio 2.0.4, the following

## App <span>foo</span>

leads to toc in the table of contents but to doc in the document itself.

I'd prefer having the HTML not escaped in the table of contents allowing e.g. custom badges. In my opinion, it should at least be consistent between table of contents and document whether HTML is escaped or not.

danielgtaylor commented 9 years ago

Thanks for catching this!

winniehell commented 9 years ago

EDIT: Comment split into new issue #162.

danielgtaylor commented 9 years ago

I agree that the generated header names with HTML are a difficult problem and I've approached them as best I could. Definitely open to suggestions, but please open a new issue.

The originally reported issue is now fixed in the 1.2.1 release of the Olio theme engine.

winniehell commented 9 years ago

This is awesome! :heart:

The following

# Group <strong>Important</strong> Stuff

## Bar <span class="badge"><i class="fa fa-plane"></i></span>

now renders like this in the table of contents: toc

So you can now use custom badges very easily. :+1:

Sorry, the second comment was just random thoughts while I was not in office. I'll open another issue.