Skip to content

TEv1 bug - writing comments immediately behind a docusaurus header.

The file concept-file.md in the dir terminology-engine-v1-templates starts with:

---
id: conceptID
title: "NameOfNewConcept"
scopeid: scopeID
type: concept
typeid: conceptID
stage: draft
hoverText: "popuptext for 'conceptID' (tbd)"
---
<!--A concept tries to capture the idea behind a classification of entities, allowing us to reason about everything in the class as if it were one thing. This file specifies the idea(s) that, within the scope of `<existing-scopeID>` will be referred to using `<New Term>`.
Please fill in the placeholders in this file as follows:
- `<existing-scopeID>`: machine readable text that identifies the scope in which this term is defined;
- `<Existing Scope>`: human readable text that identifies the scope in which this term is defined;
- `<new-termID>`: machine readable text that identifies this term within `<existing-scopeID>`;
- `<New Term>`: human readable text that identifies this term within `<Existing Scope>`;
-->

Compiling the lot (with docker) produces:

essif-lab-terminology    | ./docs/terminology-engine-v1-templates/concept-file.md
essif-lab-terminology    | SyntaxError: /app/docs/terminology-engine-v1-templates/concept-file.md: Unexpected token (2:0)
essif-lab-terminology    |
essif-lab-terminology    |   1 | import { Term } from '../../src/components'
essif-lab-terminology    | > 2 | <!--A concept tries to capture the idea behind a classification of entities, allowing us to reason about everything in the class as if it were one thing. This file specifies the idea(s) that, within the scope of `<existing-scopeID>` will be referred to using `<New Term>`.
essif-lab-terminology    |     | ^
essif-lab-terminology    |   3 | Please fill in the placeholders in this file as follows:
essif-lab-terminology    |   4 | - `<existing-scopeID>`: machine readable text that identifies the scope in which this term is defined;
essif-lab-terminology    |   5 | - `<Existing Scope>`: human readable text that identifies the scope in which this term is defined;
essif-lab-terminology    |  @ ./.docusaurus/registry.js 1:7813-7894 1:7647-7749
essif-lab-terminology    |  @ ./node_modules/@docusaurus/core/lib/client/exports/ComponentCreator.js
essif-lab-terminology    |  @ ./.docusaurus/routes.js
essif-lab-terminology    |  @ ./node_modules/@docusaurus/core/lib/client/clientEntry.js
essif-lab-terminology    |  @ multi ./node_modules/@docusaurus/core/lib/client/clientEntry.js
essif-lab-terminology    | Client bundle compiled with errors therefore further build is impossible.
essif-lab-terminology    | ./docs/terminology-engine-v1-templates/concept-file.md
essif-lab-terminology    | Module build failed (from ./node_modules/@docusaurus/mdx-loader/src/index.js):
essif-lab-terminology    | SyntaxError: /app/docs/terminology-engine-v1-templates/concept-file.md: Unexpected token (2:0)

If I add an empty line immediately behind ---, the problem goes away.

This ticket requests the insertion of a new line before and/or behind the import statement (wherever appropriate for fixing this).