[
https://issues.apache.org/jira/browse/ZOOKEEPER-4356?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Nihal Jain updated ZOOKEEPER-4356:
----------------------------------
Description:
The code blocks defined inside fenced code blocks render correctly in Markdown;
but the same text 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!
was:
The code blocks defined inside fenced code blocks render correctly in Markdown;
but the same text not render properly in HTML sites.
For example see:
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 makes the docs site very ugly and difficult to comprehend. (One has to
figure out where the code block starts and where it ends.)
> 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 blocks defined inside fenced code blocks render correctly in
> Markdown; but the same text 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)
