From 6d5dc8e3f89cb8fed5c11d89b95730f56f9889d3 Mon Sep 17 00:00:00 2001 From: dvs1 Date: Sun, 22 Dec 2024 04:17:59 +1000 Subject: Update and tweak the README. --- README | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README b/README index 334cea4..aedd92a 100644 --- a/README +++ b/README @@ -1,6 +1,6 @@ --- favicon: cartdave_favicon.png -pagetitle: "notYetAnotherWiki is not another wiki, at least not yet. It'll be much more than that, eventually." +pagetitle: "notYetAnotherWiki" author: onefang feedatom: https://sledjhamr.org/cgit/notYetAnotherWiki/atom history: https://sledjhamr.org/cgit/notYetAnotherWiki/log/index.md @@ -10,17 +10,26 @@ sourcecode: https://sledjhamr.org/cgit/notYetAnotherWiki/ notYetAnotherWiki is not another wiki, at least not yet. It'll be much more than that, eventually. +## not a wiki, yet + So to start with it's not a wiki. It's currently a way to create a web -site with CommonMark wiki markup, using git to update the content. +site with [CommonMark](https://commonmark.org/) wiki markup, using git to +update the content. So it's not a wiki, yet. +## barely a wiki + Next comes accounts and online editing of content with the web pages. It'll then barely be a wiki. +# Yet Another Wiki + The missing bit is talk pages, which requires some sort of archiving chat system built into the thing. Now it's Yet Another Wiki. +# not Yet Another Wiki + Finally comes the magic, so it's "not Yet Another Wiki", it's much more than that. @@ -32,7 +41,8 @@ Only difference between an instant messaging system and a web forum is how fast it runs. So just make this fast, then we can call it an instant messaging system. -Put email behind a web forum, you got a mailing list with a web archive. +Put email behind a web forum, you got a mailing list with a web archive. +Some of them support email anyway. An issue tracker is basically a wiki type page with the forum style messages, and often an email control system. Only that last bit needs to @@ -56,7 +66,7 @@ the one system. They can chat about it, on the one system. ## What does it do already? -Currently it'll scan the current directory and subdirectories rooking for +Currently it'll scan the current directory and subdirectories looking for .md files in CommonMark syntax. This should cover some MarkDown variations. Then it produces .HTML files converted from these .md files, and links them all together into a web site. @@ -65,3 +75,6 @@ git is used to store the .md files, and provides edit history. Added on the footer is links to cgit, which is used to store the files in git on your server. This provides acces to the source code, history, and ATOM feed for the site. + +It can also scan an external directory and merge that with the current +one, but this isn't tested yet. -- cgit v1.1