dhall-docs: render standalone text files as preformatted text (#2565)

kukimik · web-flow · commit 792408282787 · 2024-01-11T08:49:30.000+01:00
diff --git a/.gitattributes b/.gitattributes
@@ -5,4 +5,5 @@
 *.golden binary
 dhall-csv/tasty/data/* binary
 dhall-docs/tasty/data/golden/**/*.html binary
+dhall-docs/tasty/data/package/StandaloneTextFile.txt binary
 dhall-yaml/tasty/data/* binary
diff --git a/dhall-docs/src/Dhall/Docs/Html.hs b/dhall-docs/src/Dhall/Docs/Html.hs
@@ -77,7 +77,7 @@ dhallFileToHtml filePath contents expr examples header params@DocParams{..} =
     htmlTitle = breadCrumbsToText breadcrumb
     clipboardText = fold baseImportUrl <> htmlTitle
 
--- | Generates an @`Html` ()@ with all the information about a dhall file
+-- | Generates an @`Html` ()@ with all the information about a non-dhall text file
 textFileToHtml
     :: Path Rel File            -- ^ Source file name, used to extract the title
     -> Text                     -- ^ Contents of the file
@@ -93,7 +93,7 @@ textFileToHtml filePath contents params@DocParams{..} =
                 copyToClipboardButton clipboardText
                 br_ []
                 h3_ "Source"
-                div_ [class_ "source-code"] (toHtml contents)
+                div_ [class_ "source-code"] $ pre_ (toHtml contents)
   where
     breadcrumb = relPathToBreadcrumb filePath
     htmlTitle = breadCrumbsToText breadcrumb
diff --git a/dhall-docs/tasty/data/golden/StandaloneTextFile.txt.html b/dhall-docs/tasty/data/golden/StandaloneTextFile.txt.html
@@ -0,0 +1,45 @@
+<!DOCTYPE HTML>
+<html>
+<head>
+<title>/StandaloneTextFile.txt</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;500;600;700&amp;family=Lato:ital,wght@0,400;0,700;1,400&amp;display=swap">
+<script type="text/javascript" src="index.js">
+</script>
+<meta charset="UTF-8">
+</head>
+<body>
+<div class="nav-bar">
+<img class="dhall-icon" src="dhall-icon.svg">
+<p class="package-title">test-package</p>
+<div class="nav-bar-content-divider">
+</div>
+<a id="switch-light-dark-mode" class="nav-option">Switch Light/Dark Mode</a>
+</div>
+<div class="main-container">
+<h2 class="doc-title">
+<span class="crumb-divider">/</span>
+<a href="index.html">test-package</a>
+<span class="crumb-divider">/</span>
+<span class="title-crumb" href="index.html">StandaloneTextFile.txt</span>
+</h2>
+<a class="copy-to-clipboard" data-path="/StandaloneTextFile.txt">
+<i>
+<small>Copy path to clipboard</small>
+</i>
+</a>
+<br>
+<h3>Source</h3>
+<div class="source-code">
+<pre>This is a text file that is not referenced by any dhall file.
+
++---------------------------------------------------+
+| It should be displayed as &lt;pre&gt;preformatted&lt;/pre&gt; |
+|   text, with horizontal and vertical whitespace   |
+|          preserved, to keep it readable.          |
++---------------------------------------------------+
+</pre>
+</div>
+</div>
+</body>
+</html>
diff --git a/dhall-docs/tasty/data/golden/index.html b/dhall-docs/tasty/data/golden/index.html
@@ -171,6 +171,9 @@ <h3>Exported files: </h3>
 </span>
 </li>
 <li>
+<a href="StandaloneTextFile.txt.html">StandaloneTextFile.txt</a>
+</li>
+<li>
 <a href="TwoAnnotations.dhall.html">TwoAnnotations.dhall</a>
 <span class="of-type-token">:</span>
 <span class="dhall-type source-code">
diff --git a/dhall-docs/tasty/data/package/StandaloneTextFile.txt b/dhall-docs/tasty/data/package/StandaloneTextFile.txt
@@ -0,0 +1,7 @@
+This is a text file that is not referenced by any dhall file.
+
++---------------------------------------------------+
+| It should be displayed as <pre>preformatted</pre> |
+|   text, with horizontal and vertical whitespace   |
+|          preserved, to keep it readable.          |
++---------------------------------------------------+
