| 1 | Shroomgit: shindex shgit
|
| 2 | ========================
|
| 3 | Quickly generate a static html page of your git repos
|
| 4 |
|
| 5 |
|
| 6 | Requirements
|
| 7 | ------------
|
| 8 | git
|
| 9 | go
|
| 10 |
|
| 11 |
|
| 12 | Installation
|
| 13 | ------------
|
| 14 |
|
| 15 | git clone https://git.disroot.org/davidv/shroomgit.git
|
| 16 | cd shroomgit
|
| 17 | make
|
| 18 |
|
| 19 | The shindex and shgit binaries will be within the bin/ directory
|
| 20 |
|
| 21 |
|
| 22 | Documentation
|
| 23 | -------------
|
| 24 | 1) shindex: generate an index page of various repositories
|
| 25 |
|
| 26 | shindex repo1 repo2 ... > site.html
|
| 27 |
|
| 28 | Shindex directory outputs HTML code, use that to direct it to where you
|
| 29 | want. Shindex works with an unlimited amount of repositories as input.
|
| 30 |
|
| 31 | Within shared/shared.go, the logo, the page title, and description can
|
| 32 | be configured and edited.
|
| 33 |
|
| 34 | 2) shgit: generate pages for a repository
|
| 35 |
|
| 36 | shgit repo output_dir
|
| 37 | shgit repo
|
| 38 |
|
| 39 | Still very much a work in progress. Shgit takes a repository as an
|
| 40 | argument and outputs multiple HTML files and directories into either a
|
| 41 | specified directory or, if no output directory is given, into the
|
| 42 | working directory.
|
| 43 |
|
| 44 | Within shared/shared.go, configuration of the logo and favicon can be
|
| 45 | set.
|
| 46 |
|
| 47 |
|
| 48 | License
|
| 49 | -------
|
| 50 | unlicense license <https://unlicense.org/>
|
