Home Explore Help
Register Sign In
swatson
/
git-site-gen
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 855c66cba2
Branches Tags
git-site-gen
/
README.md

README.md 1.3 KB
History Raw

git-site-gen

Placeholder repo right now as code is not ready to be public. Tracking features/TODO's in this README.

Features/Plans/TODO

  • 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

Framework Plans

  • gsg -- Perl script to generate the site, uses modules below
  • Shellex.pm -- lib to handle shell calls (can likely split Shellex from simply-git project into it's own repo and maintain it there for both things)
  • GitGather.pm -- module to assemble data structures from git trees that need to be obtained as part of generating the site
  • Html.pm -- probably a bad name, used for writing HTML files and/or editing text in other data structures with html content
  • MdParse.pm -- module for parsing markdown. Likely a fools errand to be writing this myself but I'd like to try
  • GsgConfigParse.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)