No description
Find a file
2024-06-29 00:10:14 +02:00
templates Add embedded templates and a test index template 2024-06-29 00:10:14 +02:00
.gitignore Add embedded templates and a test index template 2024-06-29 00:10:14 +02:00
gitstatic.go Add embedded templates and a test index template 2024-06-29 00:10:14 +02:00
go.mod Initial commit with a sample index implemented 2024-06-28 19:28:42 +02:00
go.sum Initial commit with a sample index implemented 2024-06-28 19:28:42 +02:00
Makefile Initial commit with a sample index implemented 2024-06-28 19:28:42 +02:00
README.md Add embedded templates and a test index template 2024-06-29 00:10:14 +02:00

Gitstatic

Simple CLI tool to generate webpages from git repositories.

Roadmap

  • Embed templates for the index and repository pages.
  • Generate the index html file for the -index subcommand.
  • Generate the log html file for a repository.
  • Detect and link README, LICENSE and CONTRIBUTING files.
  • Generate the files html file and file structure.
  • Generate the refs html file.
  • Add a proper CLI parsing and subcommands.
  • Add a sample CSS file for the default templates.
  • Add a subcommand to dump the embedded templates so they can be modified.
  • Take binary files into account.
  • Limit the output for large diffs.
  • Allow to anchor lines.
  • Check if the templates exist on a location and use them if so. Allow to change that location through CLI flags or env vars.
  • Optimize repository generation through a cache.
  • Add a flag to regenerate in case a push -f comes in.
  • Optimize output generation through the use of smaller templates instead of having all the structs in memory when executing one template (for large repos).
  • Add an atom feed for the repositories.
  • Add a flag for raw file generation for HEAD.
  • Add a flag for syntax highlighting through Chroma.
  • Add a flag for markdown to HTML.
  • Investigate the viability of generating tarballs for certain refs.