git.mcksp
    1
    2
    3
    4
    5
    6
    7
    8
    9
   10
   11
   12
   13
   14
   15
   16
   17
   18
   19
   20
   21
   22
   23
   24
   25
   26
   27
   28
   29
   30
   31
   32
   33
   34
   35
   36
   37
   38
   39
   40
   41
   42
   43
   44
   45
   46
   47
   48
   49
   50
   51
   52
   53
   54
   55
   56
   57
   58
   59
   60
   61
   62
   63
   64
   65
   66
   67
   68
   69
<!doctype html>
<!--title:gituwa: static git web frontend generator-->
<!--date:2023/08/23-->
<html lang='en'>
    <head>
        <meta charset='UTF-8'>
        <meta name='viewport' content='width=device-width, initial-scale=1.0'>
        <meta name='author' content='Maciej Spychala' />
        <title>gituwa: static git web frontend generator</title>
        <link type='text/css' rel='stylesheet' href='/assets/style.css'>
    </head>
    <body>
        <header>
            <a id='title' href='/'>mcksp</a></span>
            <div id='navbar'>
                <a href='/blog'>blog</a>
                <a href='/tech'>tech</a>
                <a href='https://git.mcksp.com'>git</a>
                <a href='/about'>about</a>
                <a href='/rss.xml'>rss</a>
            </div>
        </header>
<h1>gituwa: static git web frontend generator</h1>

<p>
<b><code>gituwa</code></b> is static git web frontend generator.
You can find it self-hosted <a href='https://git.mcksp.com/gituwa'>here</a>.
</p>

<p>
It lets you browse file tree, display file content,
and also prepare nice repo main page with file tree,
photo of your project and README.
</p>

Usage of gituwa:
<p><code>gituwa [repo_path] [output_path] [repository_description]</code></p>

<p>
where <code>repo_path</code> can be a path to <code>bare</code> repository, and
<code>repository description</code> is a short text that will be displayed next to
name of the repository.
</p>

<p>
To update files automatically on <code>git push</code> I recommend updating <code>post-receive</code>
hook of repositories to include call of <code>gituwa</code>.
</p>

<p>
I was looking for something like that for my site, and I found <a href='https://git.codemadness.org/stagit/files.html'>stagit</a>,
which is great software, but I decided to implement something simpler by myself.
So in terms of features <code>gituwa</code> is definitely a subset of <code>stagit</code>
except directory structure in file tree and added image on the main page of repository.
</p>

<p>
I think that image makes a lot of difference when looking at repositories of strangers
on the internet, as it removes barrier of cloning and compiling a thing to see what it
is really about
</p>

<img class='center' src='/assets/tech/gituwa/gituwa.png'>

        <footer>
            made with <a href='https://git.mcksp.com/brcl'>brcl</a>
        </footer>
    </body>
</html>