[
https://issues.apache.org/jira/browse/ZOOKEEPER-4356?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17405808#comment-17405808
]
Nihal Jain edited comment on ZOOKEEPER-4356 at 8/27/21, 12:59 PM:
------------------------------------------------------------------
Created PR. See site rendering with a local build having the fix below:
!html_rendering_after_fix.png!
was (Author: nihaljain.cs):
Created PR. See local build fix at !html_rendering_after_fix.png!
> Code blocks do not render correctly in ZK docs site
> ---------------------------------------------------
>
> Key: ZOOKEEPER-4356
> URL: https://issues.apache.org/jira/browse/ZOOKEEPER-4356
> Project: ZooKeeper
> Issue Type: Bug
> Components: documentation
> Affects Versions: 3.7.0
> Reporter: Nihal Jain
> Priority: Major
> Labels: pull-request-available
> Attachments: html_rendering_after_fix.png,
> html_rendering_before_fix.png, markdown_rendering.png
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> 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
>
> !markdown_rendering.png!
> vs
> http://zookeeper.apache.org/doc/current/zookeeperCLI.html
> !html_rendering_before_fix.png!
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
