From c92f4ceaccd51cedee417f4634f14b24d6f0df80 Mon Sep 17 00:00:00 2001
From: sterni <sternenseemann@systemli.org>
Date: Wed, 12 May 2021 16:50:40 +0200
Subject: refactor(web/atward): translate index page to markdown

Change-Id: I03ccbec1dd8ba58d80bd97eb40148dd395e500b2
Reviewed-on: https://cl.tvl.fyi/c/depot/+/3115
Tested-by: BuildkiteCI
Reviewed-by: tazjin <mail@tazj.in>
---
 web/atward/indexHtml/default.nix | 104 ++++++++++++++++++---------------------
 1 file changed, 48 insertions(+), 56 deletions(-)

(limited to 'web/atward/indexHtml')

diff --git a/web/atward/indexHtml/default.nix b/web/atward/indexHtml/default.nix
index acb7b6acc7..56e2f0e1b5 100644
--- a/web/atward/indexHtml/default.nix
+++ b/web/atward/indexHtml/default.nix
@@ -4,56 +4,49 @@ depot.web.tvl.template {
   useUrls = true;
   title = "atward";
   content = ''
-    <p>
-      <b>atward</b> is <a href="https://tvl.fyi/">TVL's</a> search
-      service. It can be configured as a browser search engine for easy
-      access to TVL bugs, code reviews, code paths and more.
-    </p>
-
-    <h3>Setting up atward</h3>
-    <p>
-      To configure atward, add a search engine to your browser with the
-      following search string:
-      <pre>  https://at.tvl.fyi/?q=%s</pre>
-      Consider setting a shortcut, for example <b>t</b> or <b>tvl</b>.
-      You can now quickly access TVL resources by typing something
-      like <kbd>t b/42</kbd> in your URL bar to get to the bug with ID
-      42.
-    </p>
-
-    <h3>Supported queries</h3>
-    <p>
-      The following query types are supported in atward:
-      <ul>
-        <li><kbd>b/42</kbd> - access bugs with ID 42</li>
-        <li><kbd>cl/3087</kbd> - access changelist with ID 3087</li>
-        <li><kbd>//web/atward</kbd> - open the <b>//web/atward</b> path in TVLs monorepo</li>
-      </ul>
-    </p>
-
-    <h3>Configuration</h3>
-    <p>
-      Some behaviour of atward can be configured by adding query
-      parameters to the search string:
-      <ul>
-        <li><kbd>cs=true</kbd> - use Sourcegraph instead of cgit to view code</li>
-      </ul>
-    </p>
-    <p>
-      In some browsers (like Firefox) users can not edit query
-      parameters for search engines. As an alternative configuration can
-      be supplied via cookies with the same names as the configuration
-      parameters.
-    </p>
-    <p>
-      The form below can set this configuration:
-      <form class="cheddar-callout cheddar-todo">
-        <input type="checkbox"
-               id="cs-setting"
-               onchange="saveSetting(this, 'cs');"
-               > Use Sourcegraph instead of cgit</input>
-      </form>
-    </p>
+    **atward** is [TVL's](https://tvl.fyi/) search
+    service. It can be configured as a browser search engine for easy
+    access to TVL bugs, code reviews, code paths and more.
+
+    ### Setting up atward
+
+    To configure atward, add a search engine to your browser with the
+    following search string: `https://at.tvl.fyi/?q=%s`
+    Consider setting a shortcut, for example **t** or **tvl**.
+    You can now quickly access TVL resources by typing something
+    like <kbd>t b/42</kbd> in your URL bar to get to the bug with ID
+    42.
+
+
+    ### Supported queries
+
+    The following query types are supported in atward:
+
+    * <kbd>b/42</kbd> - access bugs with ID 42
+    * <kbd>cl/3087</kbd> - access changelist with ID 3087
+    * <kbd>//web/atward</kbd> - open the **//web/atward** path in TVLs monorepo
+
+    ### Configuration
+
+    Some behaviour of atward can be configured by adding query
+    parameters to the search string:
+
+    * <kbd>cs=true</kbd> - use Sourcegraph instead of cgit to view code
+
+
+    In some browsers (like Firefox) users can not edit query
+    parameters for search engines. As an alternative configuration can
+    be supplied via cookies with the same names as the configuration
+    parameters.
+
+    The form below can set this configuration:
+    <form class="cheddar-callout cheddar-todo">
+      <input type="checkbox"
+             id="cs-setting"
+             onchange="saveSetting(this, 'cs');"
+             > Use Sourcegraph instead of cgit</input>
+    </form>
+
     <noscript>
       <p class="cheddar-callout cheddar-warning">
         The form above only works with Javascript enabled. Only a few
@@ -62,12 +55,11 @@ depot.web.tvl.template {
       </p>
     </noscript>
 
-    <h3>Source code</h3>
-    <p>
-      atward's source code lives
-      at <a href="https://atward.tvl.fyi/?q=%2F%2Fweb%2Fatward">//web/atward</a>.
-    </p>
-    '';
+    ### Source code
+
+    atward's source code lives at
+    [//web/atward](https://atward.tvl.fyi/?q=%2F%2Fweb%2Fatward).
+  '';
   extraHead = ''
     <script>
       /* Initialise the state of all settings. */
-- 
cgit 1.4.1