github/repo2html
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

bit more in the readme about new template variables

Browse source
This commit is contained in:
pho4cexa 2023-01-08 09:37:46 -08:00
parent 0eece2a92e
commit b26b6eea15
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -119,8 +119,11 @@ Environment variables may also be used for configuration, and take precedence ov
Your repository "name" is, by default, the name of the directory as specified in the first argument provided to `repo2html`. Your repository "name" is, by default, the name of the directory as specified in the first argument provided to `repo2html`.
This affects the template variables: You may override this if you prefer a more human-friendly name, for example:
This does not affect the template variables:
`git config repo2html.name "Git Repository To Hypertext Markup Language Generator"`
This affects the template variable `repository_name` but not `repository_path`.
### Description ### Description
@ -142,15 +145,17 @@ This is a helper intended for use when [building a git forge](#creating-a-git-fo
It specifies the filesystem path to the directory containing (possibly a hierarchy of) html output directories. It specifies the filesystem path to the directory containing (possibly a hierarchy of) html output directories.
This affects the template variables `repository_path`, `repository_path_parent`, and `repository_ancestors`, when the repo is found to be in a subdirectory of `ForgeRoot`.
Example: Example:
With forgeroot unset, the command With forgeroot unset, the command
`repo2html /var/www/repos/mike/projecta/repo1 /path/to/templates` `repo2html /var/www/repos/mike/projecta/repo1 /path/to/templates`
will set the variable repo_path to `repo1` will set the variable `repository_path` to `repo1`
With forgeroot set to `/var/www/repos`, the command With forgeroot set to `/var/www/repos`, the command
`repo2html /var/www/repos/mike/projecta/repo1 /path/to/templates` `repo2html /var/www/repos/mike/projecta/repo1 /path/to/templates`
will set the variable repo_path to `mike/projecta/repo1` will set the variable `repository_path` to `mike/projecta/repo1`
When your forge is built with a shared git user, it's convenient to use --global to specify this just once, like: When your forge is built with a shared git user, it's convenient to use --global to specify this just once, like: