From 1fcf914fd87c4e14adadcac2caaf46e120924d77 Mon Sep 17 00:00:00 2001 From: Zack Scholl Date: Wed, 10 Feb 2016 16:51:19 -0500 Subject: [PATCH] Added custom about page Former-commit-id: 9597bb69c77b75b0a4f1cf6f8b30f720c0a33151 [formerly 173948ba3a04787ab127644511b4fde0b9863c48] [formerly aee11d133cb4c4a58f8c3b9f378c0b69e02b7c46 [formerly b20d01feb3adae58644786727a54964eefcaa7e0 [formerly 61149c3790a80b5a936f6f0b17962124f484cf54]]] Former-commit-id: 1847093ec44bcf1c7a7399b0ab1ced3394b07a0d [formerly 9a88a34446c2eddcb28a652e10302d43c3bea2a4] Former-commit-id: 604572a6e571dc93c7f80d844026407e520b3d77 Former-commit-id: 52bf64dfb1306177d92009186ea19c50beb7ad16 --- main.go | 4 +++- templates/aboutpage.md | 20 ++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 templates/aboutpage.md diff --git a/main.go b/main.go index ee0217b..e17b2f7 100644 --- a/main.go +++ b/main.go @@ -3,6 +3,7 @@ package main import ( "flag" "fmt" + "io/ioutil" "log" "path" "runtime" @@ -63,7 +64,8 @@ Options:`) defer Close() // Default page - p := WikiData{"about", aboutPageText + "\n" + VersionNum, []string{}, []string{}} + aboutFile, _ := ioutil.ReadFile(path.Join(RuntimeArgs.SourcePath, "templates/aboutpage.md")) + p := WikiData{"about", string(aboutFile), []string{}, []string{}} p.save(aboutPageText) // var q WikiData diff --git a/templates/aboutpage.md b/templates/aboutpage.md new file mode 100644 index 0000000..142c8ff --- /dev/null +++ b/templates/aboutpage.md @@ -0,0 +1,20 @@ +![Logo](https://i.imgur.com/ixnBYOl.png) + +# AwwKoala +## A Websocket Wiki and Kind Of A List Application +![Version 1.0](https://img.shields.io/badge/version-1.0-brightgreen.svg) + +This is a self-contained wiki webserver that makes sharing easy and _fast_. You can make any page you want, and any page is editable by anyone. Pages load instantly for editing, and have special rendering for whether you want to view as a web page or view as list. + +# Features +## Just type. +To jot a note, simply load the page at [`/`](http://AwwKoala.com/) and just start typing. No need to press edit, the browser will already be focused on the text. No need to press save - it will automatically save when you stop writing. The URL at [`/`](http://AwwKoala.com/) will redirect to an easy-to-remember name that you can use to reload the page at anytime, anywhere. But, you can also use any URL you want, e.g. [`/AnythingYouWant`](http://AwwKoala.com/AnythingYouWant). + +## Views +All pages can be rendered into HTML by adding `/view`. For example, the page [`/AnythingYouWant`](http://AwwKoala.com/AnythingYouWant) is rendered at [`/AnythingYouWant/view`](http://AwwKoala.com/AnythingYouWant/view). You can write in HTML or [Markdown](https://daringfireball.net/projects/markdown/) for page rendering. Math is supported with [Katex](https://github.com/Khan/KaTeX) using `$\frac{1}{2}$` for inline equations and `$$\frac{1}{2}$$` for regular equations. + +## Lists +If you are writing a list and you want to tick off things really easily, just add `/list`. For example, after editing [`/grocery`](http://AwwKoala.com/grocery), goto [`/grocery/list`](http://AwwKoala.com/grocery/list). In this page, whatever you click on will be striked through and moved to the end. This is helpful if you write a grocery list and then want to easily delete things from it. + +## Automatic versioning +All previous versions of all notes are stored and can be accessed by adding `?version=X` onto `/view` or `/edit`. If you are on the `/view` or `/edit` pages the menu below will show the most substantial changes in the history. Note, only the _current_ version can be edited (no branching allowed, yet).