Skip to content

Build broken by references in scs-0126 #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
garloff opened this issue Apr 9, 2025 · 1 comment
Closed

Build broken by references in scs-0126 #307

garloff opened this issue Apr 9, 2025 · 1 comment

Comments

@garloff
Copy link
Member

garloff commented Apr 9, 2025

The docs page build breaks with

Error:  Client bundle compiled with errors therefore further build is impossible.
Error: MDX compilation failed for file "/home/runner/work/docs/docs/standards/scs-0126-v1-provider-networks.md"
Cause: Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)
Details:
{
  "column": 16,
  "message": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "line": 247,
  "name": "247:16",
  "place": {
    "line": 247,
    "column": 16,
    "offset": 21316,
    "_index": 0,
    "_bufferIndex": 7
  },
  "reason": "Unexpected character `/` (U+002F) before local name, expected a character that can start a name, such as a letter, `$`, or `_` (note: to create a link in MDX, use `[text](url)`)",
  "ruleId": "unexpected-character",
  "source": "micromark-extension-mdx-jsx",
  "url": "https://github.com/micromark/micromark-extension-mdx-jsx#unexpected-character-at-expected-expect"
}

This points to

[^bgp]: <https://docs.openstack.org/neutron/2024.1/admin/config-bgp-dynamic-routing.html>
               ^

(The first slash after the https:)

Apparently, docusaurus does not like to create reference lists with link embedded in <>.

@garloff
Copy link
Member Author

garloff commented Apr 9, 2025

The PR SovereignCloudStack/standards#901 fixed this one.
For a more generic discussion see #308 .

@garloff garloff closed this as completed Apr 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant