Uploaded image for project: 'ZooKeeper'
  1. ZooKeeper
  2. ZOOKEEPER-4356

Code blocks do not render correctly in ZK docs site

    XMLWordPrintableJSON

Details

    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

      Attachments

        1. markdown_rendering.png
          54 kB
          Nihal Jain
        2. html_rendering_before_fix.png
          117 kB
          Nihal Jain
        3. html_rendering_after_fix.png
          81 kB
          Nihal Jain

        Issue Links

          Activity

            People

              Unassigned Unassigned
              nihaljain.cs Nihal Jain
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 50m
                  50m