Skip to content

Fail build if text block contains HTML comment markup #80

@chrispcampbell

Description

@chrispcampbell

We have had a couple cases where some HTML comments were accidentally included in the base (English) translation files. Often this is the result of accidentally putting a improperly formatted "command" like def or section inside a begin-def/end-def block, which is not allowed:

<!-- begin-def:example_1 -->

This is a sentence with __bold__ and _italic_ text.

<!-- OOPS -->

This block has two paragraphs that are captured using a `begin-def` / `end-def` pair.

<!-- end-def -->

We can make docs-builder throw an error if HTML comment syntax is detected, which should help catch cases like this earlier.

Metadata

Metadata

Labels

improvementInternal improvement or refactoring

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions