Skip to content

[Feature Request]: Parse substitutions as Markdown #1047

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
2 tasks done
swallez opened this issue Apr 8, 2025 · 2 comments
Closed
2 tasks done

[Feature Request]: Parse substitutions as Markdown #1047

swallez opened this issue Apr 8, 2025 · 2 comments

Comments

@swallez
Copy link
Member

swallez commented Apr 8, 2025

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

The previous doc system considered substitution values as AsciiDoc markup. The new system considers them as plain text.

The Java client was using this to insert a paragraph at the end of pages containing code samples linking to the complete source of theses samples in the GitHub repository (see substitution definition and its usage). Using a substitution for this reduces typing and ensures consistency.

Using snippets is a workaround that works in this specific case, but snippets are blocks and thus cannot be used for inline snippets such as a name and a link.

Proposed Solution

Expand substitutions before rendering markup.

Examples and Research

No response

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Nice to have

@shainaraskas
Copy link
Contributor

I believe this is the same issue or related: #152

@swallez
Copy link
Member Author

swallez commented Apr 10, 2025

Indeed you're right, I didn't use proper search terms to find it. Closing, then.

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

No branches or pull requests

2 participants