No frills static page generator for Git repositories
git clone https://git.8pit.net/depp.git
1.Dd $Mdocdate: May 10 2020 $ 2.Dt DEPP 1 3.Os 4.Sh NAME 5.Nm depp 6.Nd generate HTML files for a git repository 7.Sh SYNOPSIS 8.Nm depp 9.Op Fl c Ar commits10.Op Fl d Ar destination11.Op Fl u Ar URL12.Ar repository13.Sh DESCRIPTION14For the given15.Xr git 116.Ar repository17.Nm18generates static HTML files which provide a simple repository overview.19This includes recent commits, a file tree, and (rendered) README files.20In regards to the file tree,21.Nm22only operates on the current repository head.23.Pp24This software is most commonly invoked from a25.Pa post-receive26hook registered on the Git server.27Thereby causing generated HTML to be updated automatically.28Refer to29.Xr githooks 530for more information on these hooks.31.Pp32The options are as follows:33.Bl -tag -width Ds34.It Fl c Ar commits35Amount of36.Ar commits37to include on the index page.38For each commit the commit message, the author name, and the commit date are displayed.39By default the last 5 commits are displayed.40.It Fl d Ar destination41The generated HTML file are written to the given42.Ar destination43directory.44This directory is created if it does not exist yet.45By default a46.Pa www47subdirectory is created and used in the current directory.48.It Fl u Ar URL49The50.Ar URL51used to clone the repository.52If provided, this information is displayed in the header of each generated HTML page.53.El54.Sh FILES55The following special files in bare Git repositories are recognized:56.Bl -tag -width Ds57.It Pa git-description58Contains a short description of the repository which is displayed in the header of each HTML file (if present).59.It Pa git-render-readme60Executable file which receives61.Pa README62files on standard input and should write HTML for these files to standard output.63.El64.Sh EXIT STATUS65.Ex -std depp66.Sh SEE ALSO67.Xr git 1 ,68.Xr gitweb 1 ,69.Xr githooks 570.Sh AUTHORS71.An Sören Tempel Aq Mt soeren@soeren-tempel.net72.Sh CAVEATS73Existing HTML files are not tracked by this utility.74If a file is removed from the repository, it is not automatically removed from the .Ar destination directory.