mgdelacroix/gitssg
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
gitssg/README.md
Miguel de la Cruz 847f5a0629 Adds the README file with a roadmap
2024-06-28 19:39:31 +02:00

941 B
Raw Blame History

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.
  • Add a proper CLI parsing and subcommands.
  • Add a sample CSS file for the default templates.
  • Add a subcommand to dump the embed templates.
  • 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 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.