aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README
diff options
context:
space:
mode:
authordvs12024-12-22 04:17:59 +1000
committerdvs12024-12-22 04:17:59 +1000
commit6d5dc8e3f89cb8fed5c11d89b95730f56f9889d3 (patch)
treef5ad8320c628decc784359b9ebf5fc3132f594f3 /README
parentMerge directories if converting an external directory. (diff)
downloadnotYetAnotherWiki-6d5dc8e3f89cb8fed5c11d89b95730f56f9889d3.zip
notYetAnotherWiki-6d5dc8e3f89cb8fed5c11d89b95730f56f9889d3.tar.gz
notYetAnotherWiki-6d5dc8e3f89cb8fed5c11d89b95730f56f9889d3.tar.bz2
notYetAnotherWiki-6d5dc8e3f89cb8fed5c11d89b95730f56f9889d3.tar.xz
Update and tweak the README.
Diffstat (limited to 'README')
-rw-r--r--README21
1 files changed, 17 insertions, 4 deletions
diff --git a/README b/README
index 334cea4..aedd92a 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
1--- 1---
2favicon: cartdave_favicon.png 2favicon: cartdave_favicon.png
3pagetitle: "notYetAnotherWiki is not another wiki, at least not yet. It'll be much more than that, eventually." 3pagetitle: "notYetAnotherWiki"
4author: onefang 4author: onefang
5feedatom: https://sledjhamr.org/cgit/notYetAnotherWiki/atom 5feedatom: https://sledjhamr.org/cgit/notYetAnotherWiki/atom
6history: https://sledjhamr.org/cgit/notYetAnotherWiki/log/index.md 6history: https://sledjhamr.org/cgit/notYetAnotherWiki/log/index.md
@@ -10,17 +10,26 @@ sourcecode: https://sledjhamr.org/cgit/notYetAnotherWiki/
10notYetAnotherWiki is not another wiki, at least not yet. It'll be much 10notYetAnotherWiki is not another wiki, at least not yet. It'll be much
11more than that, eventually. 11more than that, eventually.
12 12
13## not a wiki, yet
14
13So to start with it's not a wiki. It's currently a way to create a web 15So to start with it's not a wiki. It's currently a way to create a web
14site with CommonMark wiki markup, using git to update the content. 16site with [CommonMark](https://commonmark.org/) wiki markup, using git to
17update the content.
15 18
16So it's not a wiki, yet. 19So it's not a wiki, yet.
17 20
21## barely a wiki
22
18Next comes accounts and online editing of content with the web pages. 23Next comes accounts and online editing of content with the web pages.
19It'll then barely be a wiki. 24It'll then barely be a wiki.
20 25
26# Yet Another Wiki
27
21The missing bit is talk pages, which requires some sort of archiving chat 28The missing bit is talk pages, which requires some sort of archiving chat
22system built into the thing. Now it's Yet Another Wiki. 29system built into the thing. Now it's Yet Another Wiki.
23 30
31# not Yet Another Wiki
32
24Finally comes the magic, so it's "not Yet Another Wiki", it's much more 33Finally comes the magic, so it's "not Yet Another Wiki", it's much more
25than that. 34than that.
26 35
@@ -32,7 +41,8 @@ Only difference between an instant messaging system and a web forum is
32how fast it runs. So just make this fast, then we can call it an instant 41how fast it runs. So just make this fast, then we can call it an instant
33messaging system. 42messaging system.
34 43
35Put email behind a web forum, you got a mailing list with a web archive. 44Put email behind a web forum, you got a mailing list with a web archive.
45Some of them support email anyway.
36 46
37An issue tracker is basically a wiki type page with the forum style 47An issue tracker is basically a wiki type page with the forum style
38messages, and often an email control system. Only that last bit needs to 48messages, 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.
56 66
57## What does it do already? 67## What does it do already?
58 68
59Currently it'll scan the current directory and subdirectories rooking for 69Currently it'll scan the current directory and subdirectories looking for
60.md files in CommonMark syntax. This should cover some MarkDown 70.md files in CommonMark syntax. This should cover some MarkDown
61variations. Then it produces .HTML files converted from these .md files, 71variations. Then it produces .HTML files converted from these .md files,
62and links them all together into a web site. 72and 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
65the footer is links to cgit, which is used to store the files in git on 75the footer is links to cgit, which is used to store the files in git on
66your server. This provides acces to the source code, history, and ATOM 76your server. This provides acces to the source code, history, and ATOM
67feed for the site. 77feed for the site.
78
79It can also scan an external directory and merge that with the current
80one, but this isn't tested yet.