Publish markdown documentation on leiningen.org.

We should link to this instead of the stuff in the git repo because it will have better uptime.
technomancy · Jun 30, 2023 · 264b7f1 · 264b7f1
1 parent c453c67
commit 264b7f1
Show file tree

Hide file tree

Showing 6 changed files with 110 additions and 14 deletions.
diff --git a/.gitignore b/.gitignore
@@ -32,3 +32,9 @@ deps.txt
 profiles.clj
 /test/.gnupg/crls.d/DIR.txt
 /test_projects/sample/project.clj.sig
+/web/deploy.html
+/web/faq.html
+/web/plugins.html
+/web/profiles.html
+/web/templates.html
+/web/tutorial.html
diff --git a/web/Makefile b/web/Makefile
@@ -1 +1,17 @@
-upload: ; rsync -r ./ [email protected]:leiningen.org/
+DOCS=tutorial.html faq.html plugins.html profiles.html deploy.html
+
+upload: html
+	rsync -r ./ leiningen.org:leiningen.org/
+
+html: $(DOCS)
+
+# we can't set the prerequisite properly because we used uppercase
+# filenames for some reason in the markdown
+%.html:
+	pandoc --template template.html --to html -o $@ \
+		--metadata title="Leiningen $*" \
+		../doc/$(shell echo $* | tr '[:lower:]' '[:upper:]').md
+
+# TODO: css for code styles
+
+.PHONY: upload html
diff --git a/web/_foot.html b/web/_foot.html
@@ -0,0 +1,11 @@
+    <div class="sixteen columns"><hr /></div>
+
+    <div class="sixteen columns" id="footer">
+        <p>&copy; 2012-2022 Phil Hagelberg
+        and contributors. Licensed under
+        the <a href="https://codeberg.org/leiningen/leiningen/src/stable/COPYING">EPL
+        1.0</a>. See the code
+        for <a href="https://codeberg.org/leiningen/leiningen/src/main/web">this
+        site</a>.</p>
+    </div>
+    </div><!-- container -->
diff --git a/web/index.html b/web/index.html
@@ -92,27 +92,27 @@ <h3 class="offset-by-one">Documentation</h3></div>
 
     <div class="two-thirds column">
       <a name="docs"></a>
-      <p>The <a href="https://codeberg.org/leiningen/leiningen/src/stable/doc/TUTORIAL.md">tutorial</a>
+      <p>The <a href="/tutorial.html">tutorial</a>
         is the best place to start. If you have Leiningen installed,
         you can read the tutorial by running <kbd>lein help
         tutorial</kbd>. It does not cover learning the
         language itself;
-        good <a href="http://clojure-doc.org">Clojure
+        good <a href="https://clojure-doc.org">Clojure
         documentation</a> can be found elsewhere.</p>
 
 
       <p>Running <kbd>lein help faq</kbd> will get you the
-        <a href="https://codeberg.org/leiningen/leiningen/src/stable/doc/FAQ.md">FAQ</a>.
+        <a href="/faq.html">FAQ</a>.
         Documentation for each individual task is available
         via <kbd>lein help $TASK</kbd>. You can also
         see <a href="https://codeberg.org/leiningen/leiningen/src/stable/sample.project.clj">the
         sample <tt>project.clj</tt> file</a> containing a reference of most
         project settings by running <kbd>lein help sample</kbd>.</p>
 
       <p>More:
-        <a href="https://codeberg.org/leiningen/leiningen/src/stable/doc/PROFILES.md">profiles</a> |
-        <a href="https://codeberg.org/leiningen/leiningen/src/stable/doc/DEPLOY.md">deploying libraries</a> |
-        <a href="https://codeberg.org/leiningen/leiningen/src/stable/doc/PLUGINS.md">writing plugins</a> |
+        <a href="/profiles.html">profiles</a> |
+        <a href="/deploy.html">deploying libraries</a> |
+        <a href="/plugins.html">writing plugins</a> |
         <a href="https://wiki.leiningen.org/Plugins">plugin list</a>
       </p>
     </div>
@@ -144,7 +144,7 @@ <h3 class="offset-by-one">Documentation</h3></div>
     <div class="sixteen columns"><hr /></div>
 
     <div class="sixteen columns" id="footer">
-        <p>&copy; 2012-2022 Phil Hagelberg
+        <p>&copy; 2012-2023 Phil Hagelberg
         and contributors. Licensed under
         the <a href="https://codeberg.org/leiningen/leiningen/src/stable/COPYING">EPL
         1.0</a>. See the code

diff --git a/web/stylesheets/base.css b/web/stylesheets/base.css
@@ -36,8 +36,6 @@
 		display: block; }
 	body {
 		line-height: 1; }
-	ol, ul {
-		list-style: none; }
 	blockquote, q {
 		quotes: none; }
 	blockquote:before, blockquote:after,
@@ -102,10 +100,7 @@
 
 /* #Lists
 ================================================== */
-	ul, ol { margin-bottom: 20px; }
-	ul { list-style: none outside; }
-	ol { list-style: decimal; }
-	ol, ul.square, ul.circle, ul.disc { margin-left: 30px; }
+	ul, ol { margin-bottom: 20px; margin-left: 30px; }
 	ul.square { list-style: square outside; }
 	ul.circle { list-style: circle outside; }
 	ul.disc { list-style: disc outside; }

diff --git a/web/template.html b/web/template.html
@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<head>
+    <meta charset="utf-8">
+    <title>$title$</title>
+    <meta name="description" content="Leiningen: automating Clojure projects">
+    <meta name="author" content="Phil Hagelberg and contributors">
+
+    <!-- Mobile Specific Metas
+  ================================================== -->
+    <meta name="viewport"
+          content="width=device-width, initial-scale=1, maximum-scale=1">
+
+    <!-- Favicons + Manifest
+  ================================================== -->
+  <link rel="apple-touch-icon" sizes="180x180" href="/img/favicon/apple-touch-icon.png">
+  <link rel="icon" type="image/png" sizes="32x32" href="/img/favicon/favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="/img/favicon/favicon-16x16.png">
+  <link rel="manifest" href="/img/favicon/manifest.json">
+  <link rel="mask-icon" href="/img/favicon/safari-pinned-tab.svg" color="#000000">
+  <link rel="shortcut icon" href="/img/favicon/favicon.ico">
+  <meta name="msapplication-config" content="/img/favicon/browserconfig.xml">
+  <meta name="theme-color" content="#ffffff">
+
+    <!-- CSS
+  ================================================== -->
+    <link rel="stylesheet" href="stylesheets/base.css">
+    <link rel="stylesheet" href="stylesheets/skeleton.css">
+    <link rel="stylesheet" href="stylesheets/layout.css">
+    <link rel="stylesheet" href="stylesheets/htmlize.css">
+    <link rel="stylesheet" href="stylesheets/lein.css">
+</head>
+<body>
+
+  <div class="container">
+    <div class="three columns offset-by-one">
+      <img src="img/leiningen.jpg" title="logo" id="logo">
+    </div>
+    <div class="eight columns offset-by-two" id="title">
+      <h1 class="remove-bottom" style="margin-top: 40px">Leiningen</h1>
+      <h6>for automating Clojure projects without setting your hair on fire</h6>
+      <nav id="links" class="offset-by-three">
+        <a href="/#install">install</a> |
+        <a href="/#docs">docs</a> |
+        <a href="/#community">community</a> |
+        <a href="https://codeberg.org/leiningen/leiningen">source</a>
+      </nav>
+    </div>
+
+    <div class="sixteen columns"><hr /></div>
+
+    <div class="sixteen columns">
+      ${body}
+    </div>
+
+    <div class="sixteen columns"><hr /></div>
+
+    <div class="sixteen columns" id="footer">
+        <p>&copy; 2012-2023 Phil Hagelberg
+        and contributors. Licensed under
+        the <a href="https://codeberg.org/leiningen/leiningen/src/stable/COPYING">EPL
+        1.0</a>. See the code
+        for <a href="https://codeberg.org/leiningen/leiningen/src/main/web">this
+        site</a>.</p>
+    </div>
+    </div><!-- container -->
+
+</body>
+</html>