search

redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

IDs must use double quotes, not single quotes #87

Closed msuchane closed 5 years ago

msuchane commented 5 years ago

As it was explained to @VladimirSlavik by AsciiDoctor developers[1], IDs must always be surrounded by double quotes in AsciiDoc because single quotes are markup.

The problem manifests, for example, when there is a double dash in an ID:

Templates should be edited to replace single quotes with double quotes in ID.

[1] https://github.com/asciidoctor/asciidoctor/issues/2960

VladimirSlavik commented 5 years ago

I should add that such change would not break compatibility - the existing usage of single quotes is in no way affected.

There are more auto-replacements that could be applied as a surprise, not just double dash.

kalexand-rh commented 5 years ago

We merged #91, so this issue is fixed. Thanks!