https://github.com/PaulBatchelor/weewiki
A tiny wiki engine. (Fossil Export)
https://github.com/PaulBatchelor/weewiki
Last synced: about 1 month ago
JSON representation
A tiny wiki engine. (Fossil Export)
- Host: GitHub
- URL: https://github.com/PaulBatchelor/weewiki
- Owner: PaulBatchelor
- License: mit
- Created: 2020-11-28T01:50:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-29T16:23:43.000Z (almost 2 years ago)
- Last Synced: 2025-03-29T00:06:33.571Z (about 1 month ago)
- Language: C
- Homepage: https://paulbatchelor.github.io/wiki/weewiki
- Size: 1.34 MB
- Stars: 13
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - PaulBatchelor/weewiki - A tiny wiki engine. (Fossil Export) (others)
README
#+TITLE: WeeWiki
WeeWiki is a wee little wiki engine used to generate
personal wikis and mind maps.
* Building
WeeWiki is written in a literate style, and requires
[[https://git.sr.ht/~pbatch/worgle][Worgle]] to
tangle files into C code. Make sure SQLite is installed
as well.
WeeWiki can be built using the command "make". It
can then be installed using "sudo make install".
* QuickStart
To make a new page called foo:
#+BEGIN_SRC sh
weewiki add foo
#+END_SRC
Then, set foo to be some text:
#+BEGIN_SRC sh
weewiki set foo "here is a page callled foo"
#+END_SRC
If one desires to edit the page in the text editor
defined by =$EDITOR=:
#+BEGIN_SRC sh
weewiki edit foo
#+END_SRC
Save + close, and this will update the page.
To upload this README to be the homepage:
#+BEGIN_SRC sh
weewiki push README.org index
#+END_SRC
By default, wiki writes to =_site/weewiki=, so make sure
this directory exists:
#+BEGIN_SRC sh
mkdir -p _site/wiki
#+END_SRC
List all the pages with
#+BEGIN_SRC sh
weewiki ls
#+END_SRC
Export all the pages to HTML with:
#+BEGIN_SRC sh
weewiki export
#+END_SRC
And there now should be some HTML content written to
=_site/wiki=. Setting a http fileserver to point to =_site=,
one can see the generated homepage =/wiki=, and the foo page
=/wiki/foo=.