[ZOOKEEPER-4356] Code blocks do not render correctly in ZK docs site

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.7.0
• Fix Version/s: 3.5.10, 3.8.0, 3.7.1
• Component/s: documentation
• Labels: pull-request-available
• Assignee: Nihal Jain
• Reporter: Nihal Jain
• Created: 27/Aug/21 12:41
• Updated: 27/Jul/23 11:07
• Resolved: 01/Sep/21 08:48

Description

The code snippets defined inside a fenced code blocks renders correctly in Markdown; but the same code snippet does not render properly in HTML sites. This makes the docs site very ugly and difficult to comprehend. (One has to figure out where the code block starts and where it ends.)

The issue exists throughout the docs site.

For example see one of the sample pages:
https://github.com/apache/zookeeper/blob/master/zookeeper-docs/src/main/resources/markdown/zookeeperCLI.md

vs

http://zookeeper.apache.org/doc/current/zookeeperCLI.html

Issue Links

• is duplicated by: ZOOKEEPER-3807 fix the bad format when website pages build due to bash marker
• links to: GitHub Pull Request #1741