Skip to content

ogma-cli: Code blocks in tutorials do not appear highlighted #345

@ivanperez-keera

Description

@ivanperez-keera

Description

Some of the code blocks in the ROS 2, cFS and diagrams tutorials do not appear highlighted. Highlighting helps readers process and understand the code snippets, so it would be helpful to enable it.

Type

  • Feature: color code blocks in documentation.

Additional context

None.

Requester

  • Ivan Perez.

Method to check presence of bug

Not applicable (not a bug).

Expected result

For all tutorial pages, all blocks that contain code in formats recognized by Github's markdown parser have language indicators.

Desired result

For all tutorial pages, all blocks that contain code in formats recognized by Github's markdown parser have language indicators.

Proposed solution

Add language indicators to all code blocks in the tutorial pages, except for those that use a custom format or just contain logs.

Further notes

None.

Metadata

Metadata

Labels

CR:Status:ClosedAdmin only: Change request that has been completedCR:Type:FeatureAdmin only: Change request pertaining to new features requested

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions