diff options
| author | Linnnus <[email protected]> | 2024-02-01 22:59:38 +0100 |
|---|---|---|
| committer | Linnnus <[email protected]> | 2024-02-04 09:58:06 +0100 |
| commit | d38f82f6462af4e5aad6a2c776f5c00ce5b13c87 (patch) | |
| tree | 01a222792dfb10473ae4370b4fc90f3a48e1a499 /doc/simplewiki.1 | |
feat: initial commit
Here is a small overview of the state of the project at this first
commit.
I have basic Git Repo -> HTML working, and a plan for how setting up an
actual server would work (mainly, NGINX + a git hook to rebuild).
The main thing I'm working on right now is parsing WikiCreole, though I
am starting to wonder if this is the right langauge. WikiCreole is
pretty irregular and has a lot of edge cases (e.g. around emphasis).
Diffstat (limited to 'doc/simplewiki.1')
| -rw-r--r-- | doc/simplewiki.1 | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/simplewiki.1 b/doc/simplewiki.1 new file mode 100644 index 0000000..9217f00 --- /dev/null +++ b/doc/simplewiki.1 @@ -0,0 +1,24 @@ +.\" Process this file with +.\" groff -man -Tascii foo.1 +.\" +.TH SIMPLEWIKI 1 "NOVEMBER 2023" Linux "User Manuals" +.SH NAME +simplewiki \- a minimal and composable wiki system +.SH SYNOPSIS +.B simplewiki +.I bare-git-repo otuput-directory +.SH DESCRIPTION +.B simplewiki +renders the contents of the git repository at +.I bare-git-repo +to HTML, storing the results in +.I output-diretory. +Note that +.I bare-git-repo +should point to the actual directory and not the working tree. +.I output-directory +is created if it does not exists. +.SH AUTHOR +Linus <linus (at) linus dot onl> +.SH "SEE ALSO" +.BR git (1) |