improve documentation (WIP) - stagit-gopher - A git gopher frontend. (mirror)
HTML git clone git://bitreich.org/stagit-gopher/ git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/stagit-gopher/
DIR Log
DIR Files
DIR Refs
DIR Tags
DIR README
DIR LICENSE
---
DIR commit 05fb5a9a9cc33ea54b3df72f0caa762519a0ccaa
DIR parent f2e11d669c0f5b2f75980d62d129728b44bba7b0
HTML Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Thu, 15 Jun 2017 19:43:30 +0200
improve documentation (WIP)
mention geomyidae
Diffstat:
M README | 6 +++++-
M example.sh | 13 ++++---------
M stagit-gopher-index.1 | 4 +---
M stagit-gopher.1 | 14 +-------------
4 files changed, 11 insertions(+), 26 deletions(-)
---
DIR diff --git a/README b/README
@@ -1,7 +1,11 @@
stagit-gopher
=============
-static git page generator for gopher
+static git page generator for gopher.
+
+This generates pages in the geomyidae .gph file format:
+
+ http://git.r-36.net/geomyidae
Usage
DIR diff --git a/example.sh b/example.sh
@@ -3,13 +3,11 @@
# - Makes static pages for each repository directory.
#
# NOTE, things to do manually (once):
-# - copy style.css, logo.png and favicon.png manually, a style.css example
-# is included.
# - write clone url, for example "git://git.codemadness.org/dir" to the "url"
# file for each repo.
#
# Usage:
-# - mkdir -p htmldir && cd htmldir
+# - mkdir -p gphdir && cd gphdir
# - sh example.sh
# path must be absolute.
@@ -17,7 +15,7 @@ reposdir="/var/www/domains/git.codemadness.nl/home/src"
curdir=$(pwd)
# make index.
-stagit-index "${reposdir}/"*/ > "${curdir}/index.html"
+stagit-gopher-index "${reposdir}/"*/ > "${curdir}/index.gph"
# make files per repo.
for dir in "${reposdir}/"*/; do
@@ -28,13 +26,10 @@ for dir in "${reposdir}/"*/; do
mkdir -p "${curdir}/${d}"
cd "${curdir}/${d}"
- stagit -c ".cache" "${reposdir}/${r}"
+ stagit-gopher -b "/" -c ".cache" "${reposdir}/${r}"
# symlinks
- ln -sf log.html index.html
- ln -sf ../style.css style.css
- ln -sf ../logo.png logo.png
- ln -sf ../favicon.png favicon.png
+ ln -sf log.gph index.gph
printf "done\n"
done
DIR diff --git a/stagit-gopher-index.1 b/stagit-gopher-index.1
@@ -23,8 +23,6 @@ The content of the follow files specifies the meta data for each repository:
.Bl -tag -width Ds
.It .git/description or description (bare repos).
description
-.It .git/owner or owner (bare repo).
-owner of repository
.El
.Pp
For changing the style of the page you can use the following files:
@@ -37,6 +35,6 @@ favicon image.
CSS stylesheet.
.El
.Sh SEE ALSO
-.Xr stagit 1
+.Xr stagit-gopher 1
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org
DIR diff --git a/stagit-gopher.1 b/stagit-gopher.1
@@ -71,25 +71,13 @@ The content of the follow files specifies the metadata for each repository:
.Bl -tag -width Ds
.It .git/description or description (bare repo).
description
-.It .git/owner or owner (bare repo).
-owner of repository
.It .git/url or url (bare repo).
primary clone url of the repository, for example: git://git.2f30.org/stagit
.El
.Pp
When a README or LICENSE file exists in HEAD or a .gitmodules submodules file
exists in HEAD a direct link in the menu is made.
-.Pp
-For changing the style of the page you can use the following files:
-.Bl -tag -width Ds
-.It favicon.png
-favicon image.
-.It logo.png
-32x32 logo.
-.It style.css
-CSS stylesheet.
-.El
.Sh SEE ALSO
-.Xr stagit-index 1
+.Xr stagit-gopher-index 1
.Sh AUTHORS
.An Hiltjo Posthuma Aq Mt hiltjo@codemadness.org