| 1 | Shroomgit: shindex shgit
|
| 2 | ========================
|
| 3 | 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 |
|
| 25 | shindex
|
| 26 | -------
|
| 27 | generate an index page of various repositories
|
| 28 |
|
| 29 | shindex repo1 repo2 ... > site.html
|
| 30 |
|
| 31 | Shindex directory outputs HTML code, use that to direct it to where you
|
| 32 | want. Shindex works with an unlimited amount of repositories as input.
|
| 33 |
|
| 34 | Within shindex/config.go, the logo, the page title, and description can
|
| 35 | be configured and edited.
|
| 36 |
|
| 37 | * title: name of the HTML page
|
| 38 | * logo: path to the image
|
| 39 | * logoHref: redirection after clicking logo
|
| 40 | * logoWidth, LogoHeight: size customization for logo
|
| 41 | * desc: writes a description at top of page
|
| 42 |
|
| 43 |
|
| 44 | shgit
|
| 45 | -----
|
| 46 | generate pages for a repository
|
| 47 |
|
| 48 | shgit repo output_dir
|
| 49 | shgit repo
|
| 50 |
|
| 51 | Shgit takes a repository as an argument and outputs multiple HTML files
|
| 52 | and directories into either a specified directory or, if no output
|
| 53 | directory is given, into the working directory.
|
| 54 |
|
| 55 | Within shgit/config.go configuration of the logo and favicon as well
|
| 56 | as some HTML elements can be set.
|
| 57 |
|
| 58 | Shgit Config:
|
| 59 |
|
| 60 | * favicon: path to the image
|
| 61 | * logo: path to the image
|
| 62 | * logoHref: redirection after clicking logo
|
| 63 | * logoWidth, LogoHeight: size customization for logo
|
| 64 | * url: assumes the URL and repo name is the git clone location
|
| 65 |
|
| 66 | The map style is configured by default to control how lines of
|
| 67 | code and text are displayed on many pages. Further customization of
|
| 68 | HTML elements can be altered in the files within the shgit directory.
|
| 69 |
|
| 70 |
|
| 71 | License
|
| 72 | -------
|
| 73 | unlicense license <https://unlicense.org/>
|
