dunlin

commit c84cc6ef6d4009947a9f6c9775f248120babd063
parent 25d31e02622a1b16f920a167f6ef0599dcf9ecdb
Author: Daniel Barlow <dan@telent.net>
Date:   Thu, 22 Dec 2022 22:52:37 +0000

convert doc to markdown

Diffstat:
A
Makefile
 | 
2
++
M
default.nix
 | 
2
++
D
doc/index.html
 | 
46
----------------------------------------------
A
doc/index.md
 | 
32
++++++++++++++++++++++++++++++++

4 files changed, 36 insertions(+), 46 deletions(-)
diff --git a/Makefile b/Makefile
@@ -0,0 +1,2 @@
+doc/index.html: doc/index.md
+	pandoc -t html -f gfm < $< > $@
diff --git a/default.nix b/default.nix
@@ -14,6 +14,7 @@
 , lua5_3
 , makeDesktopItem
 , makeWrapper
+, pandoc
 , webkitgtk
 , writeText
 }:
@@ -48,6 +49,7 @@ in stdenv.mkDerivation rec {
     lua
     makeWrapper
     copyDesktopItems
+    pandoc
   ];
 
   makeFlags = [ "PREFIX=${placeholder "out"}" ];
diff --git a/doc/index.html b/doc/index.html
@@ -1,46 +0,0 @@
-<html><head><title>Dunlin</title></head>
-  <body>
-    <h1>Dunlin - a extensible Fennel-based web browser</h1>
-
-    <img src="dunlin.png" align="right" style="width: 33%"  />
-    <!-- original image is from
-      https://www.kansallisgalleria.fi/en/object/581328 -->
-
-    <blockquote>The dunlin (Calidris alpina) is a small wader. It is a
-    circumpolar breeder in Arctic or subarctic regions. Birds that
-    breed in northern Europe and Asia are long-distance migrants,
-    wintering south to Africa, southeast Asia and the Middle
-    East. Birds that breed in Alaska and the Canadian Arctic migrate
-    short distances to the Pacific and Atlantic coasts of North
-    America, although those nesting in northern Alaska overwinter in
-      Asia.</blockquote>
-  </body>
-
-  Dunlin is a GTK-based Webkit browser which can be extended in
-  (indeed, is mostly written in)
-  <a href="https://www.fennel-lang.org">Fennel</a>.
-
-  <h2>Hacking</h2>
-
-  <pre>
-    $ nix-shell
-    nix-shell$ overmind start -D
-    nix-shell$ overmind connect
-  </pre>
-
-  This starts a Fennel interpreter and a test runner in tmux windows.
-  Use <pre>C-b n</pre> to switch between them or <pre>C-b d</pre>
-  to detach.
-
-  <pre>
-    $ fennel dunlin.fnl &
-    $ ./repl.sh
-  </pre>
-
-  Dunlin will open a socket in <tt>$XDG_RUNTIME_DIR</tt> to allow
-  communication with a Fennel REPL. The <tt>repl.sh</tt> script
-  uses <a href="http://www.dest-unreach.org/socat/">socat</a>
-  to connect to it.
-
-
-</html>
diff --git a/doc/index.md b/doc/index.md
@@ -0,0 +1,32 @@
+# Dunlin - a extensible Fennel-based web browser
+
+<img src="dunlin.png" data-align="right" style="width: 33%" />
+
+> The dunlin (Calidris alpina) is a small wader. It is a circumpolar
+> breeder in Arctic or subarctic regions. Birds that breed in northern
+> Europe and Asia are long-distance migrants, wintering south to Africa,
+> southeast Asia and the Middle East. Birds that breed in Alaska and the
+> Canadian Arctic migrate short distances to the Pacific and Atlantic
+> coasts of North America, although those nesting in northern Alaska
+> overwinter in Asia.
+
+Dunlin is a GTK-based Webkit browser which can be extended in (indeed,
+is mostly written in) [Fennel](https://www.fennel-lang.org).
+
+## Hacking
+
+        $ nix-shell
+        nix-shell$ overmind start -D
+        nix-shell$ overmind connect
+
+
+This starts a Fennel interpreter and a test runner in tmux windows. Use `C-b n`
+to switch between them or `C-b d` to detach.
+
+        $ fennel dunlin.fnl &
+        $ ./repl.sh
+
+
+Dunlin will open a socket in `$XDG_RUNTIME_DIR` to allow communication
+with a Fennel REPL. The repl.sh script uses
+[socat](http://www.dest-unreach.org/socat/) to connect to it.