From db4f4e2a4dbba9a72698e281ff1ea8ae49930975 Mon Sep 17 00:00:00 2001
From: David Hoppenbrouwers <david@salt-inc.org>
Date: Mon, 10 Oct 2022 19:01:24 +0200
Subject: [PATCH] Add help page

---
 main.py             |  8 ++++++++
 templates/base.html |  2 ++
 templates/help.html | 19 +++++++++++++++++++
 3 files changed, 29 insertions(+)
 create mode 100644 templates/help.html

diff --git a/main.py b/main.py
index 6cef747..0dc2a8f 100644
--- a/main.py
+++ b/main.py
@@ -539,6 +539,14 @@ def admin_restart():
     restart()
     return redirect(url_for('admin'))
 
+# TODO can probably be a static-esque page, maybe?
+@app.route('/help/')
+def help():
+    return render_template(
+        'help.html',
+        title = 'Help',
+        user = get_user(),
+    )
 
 def _admin_check():
     user = get_user()
diff --git a/templates/base.html b/templates/base.html
index 9bfe742..876119c 100644
--- a/templates/base.html
+++ b/templates/base.html
@@ -27,6 +27,8 @@
 		{%- endif -%}
 		<a href="{{ url_for('login') }}">Login</a>
 		{%- endif -%}
+		<span> | </span>
+		<a href="{{ url_for('help') }}">Help</a>
 	</nav>
 	<main>
 		<h1>{{ title }}</h1>
diff --git a/templates/help.html b/templates/help.html
new file mode 100644
index 0000000..e35341e
--- /dev/null
+++ b/templates/help.html
@@ -0,0 +1,19 @@
+{% extends 'base.html' %}
+{% block content %}
+<h2>Formatting</h2>
+<ul>
+<li>
+Prepend two spaces to format code, e.g.
+<div>{{ minimd('  This is code\n  More code') | safe }}</div>
+</li>
+<li>
+Lists, starting with '- ' or '0.', '1.' ... automatically have linebreaks added.
+e.g.
+<div>{{ minimd('- Item A\n- Item B') | safe }}</div>
+Note that there must be a single space between '-' and the rest of the line.
+</li>
+<li>
+Words starting with 'http://' or 'https://' are automatically turned into links.
+</li>
+</ul>
+{% endblock %}