Skip to content

[Feature Request]: Remove console title highlighting #1826

@lcawl

Description

@lcawl

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 console codeblock support added in #375 "highlights the first line using a new custom highlighter for console code examples where the first line is the HTTP API call".

Per feedback from @drewdaemon, this formatting is unexpected where codeblocks contain multiple API calls.

Proposed Solution

Since we did not have this kind of title highlighting in the old docs (e.g. https://www.elastic.co/guide/en/elasticsearch/reference/8.19/search-your-data.html) I think it's worth considering its removal.

Examples and Research

Per @bmorelli25 "there are 1756 console code blocks in the ES repo. 293 are multi-API snippets".

Alternative Solutions

No response

Additional Context

IMO the more important feature related to Console-specific code blocks that continues to be missing from Docs V3 is #55 / #225

How important is this feature to you?

Nice to have

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions