[DISCUSSION] Custom text formatting and code snippet placeholders about docs-ui HOT 4 OPEN

Here's one approach we could take: https://github.com/riptano/astra-vector-docs/pull/265

from docs-ui.

https://github.com/riptano/astra-vector-docs/pull/265#pullrequestreview-1876576804

@kurtenj @colegoldsmith wdyt?

from docs-ui.

I'll add this item to this issue:

I see that you have a PR (https://github.com/riptano/astra-vector-docs/pull/265) to add bold to placeholders in source codeblocks. I’m guessing you do something in the antora ui to accomodate this? I’m asking, because I have a need to use italics in source codeblocks that are [source, bash], a similar issue. This would allow both bash highlighting AND italicized optional parameters to be displayed on those codeblocks. Right now, I have to pick one or the other, and Jamie and I have been looking at the google developers style guide, where they use the italicized parameters for optional params, and normal font for required params.

from docs-ui.

@polandll What you're describing doesn't appear to be an issue in the new UI.

I ran the following test:

[source,sql,subs="verbatim,quotes"]
----
CREATE TABLE smart_home.sensor_readings (
    _device_id_ UUID,
    room_id UUID,
    reading_type TEXT,
    reading_value DOUBLE,
    reading_timestamp TIMESTAMP,
    PRIMARY KEY (device_id, room_id, reading_timestamp)
) WITH CLUSTERING ORDER BY (room_id ASC, reading_timestamp DESC);
----

from docs-ui.