Accueil Explorer Aide
Connexion
swatson
/
git-site-gen
1
0
Fork 0
Fichiers Tickets 0 Pull Requests 0 Wiki

git-site-gen

Aborescence: 331a45688a
Branches Tags
git-site-gen
ZIP TAR.GZ
spesk1 331a45688a Base, nothing functional il y a 6 ans
lib 331a45688a Base, nothing functional il y a 6 ans
tools 331a45688a Base, nothing functional il y a 6 ans
README.md 331a45688a Base, nothing functional il y a 6 ans
gen_page.pl 331a45688a Base, nothing functional il y a 6 ans

README.md

git-site-gen

  • Tool used to generate a static website from information availble in a git project dir. See: https://spwbk.site/git.

    • Also provides some tools for managing your git server.

  • Inspired by the much better/full-featured https://git.suckless.org.

  • Not sure if this will be widely useful, mostly written for learning purposes.

Features

  • Generate top level index with links to all projects - POC DONE
  • Generate project specific index with links to git log/diffs and file content of repo - POC DONE
  • Diff highlighting for log
  • Line numbers for file browsing
  • README.md markdown renderer/parser / display in project index
  • Figure out way to expose clone/merge/etc interface
  • (Stretch GoaL) HTML based syntax highlighting for files

Framework Plans

  • gsg -- Perl script to generate the site, uses modules below
  • Gsg::Gather.pm -- module to assemble data structures from git trees that need to be obtained as part of generating the site
  • Gsg::Html.pm -- probably a bad name, used for writing HTML files and/or editing text in other data structures with html content
  • Gsg::MdParse.pm -- module for parsing markdown. Likely a fools errand to be writing this myself but I'd like to try
  • Gsg::ConfigParse.pm -- module to parse gsg config, might be overkill to have it's own module
    • gsg.config -- Config file that gsg reads to inform behavior (git repos dir, what to include/exclude, etc)

Deps