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

made todos and hopes types more distinguishable from the proceeding phrase

Browse source
This commit is contained in:
m455 2022-12-08 21:01:31 -05:00
parent 765d1b944f
commit 65f2c7fc7c
1 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -124,7 +124,10 @@ you can configure repo2html by changing environment variables in the `post-recei
for details about the environment variables, refer to the list below:
- `REPO2HTML_PREFIX`: the web directory where repo2html generates static git repositories. for example, `/var/www/git/`.
- `REPO2HTML_CLONE_URL`: the url that people will use when downloading your git repository. if you have git-daemon set up, then you can prefix the url with `git://`. otherwise, prefix the url with `http://`. for example, `git://git.example.com`. **note**: avoid slashes at the end of the url.
- `REPO2HTML_CLONE_URL`: the url that people will use when downloading your git
repository. if you have git-daemon set up, then you can prefix the url with
`git://`. otherwise, prefix the url with `http://`. for example,
`git://git.example.com`. **note**: avoid slashes at the end of the url.
- `REPO2HTML_TITLE`: the text that populates the `<title>` html tag.
- `REPO2HTML_DESCRIPTION`: a string that populates the `description` meta information about your git repository.
- `REPO2HTML_H1`: the text that populates the `<h1>` html tag.
@ -135,13 +138,13 @@ TODO
## todos
- documentation: convert a lot of the stuff i (m455) made in the readme into an e2e tutorial
- documenation: scope the readme audience to folks who kind of know what they're doing with servers
- feature: if no README.md file exists in the root directory of the repository, then don't create the "about" nav link. instead, make the files page the index.html
- feature: add a "license" nav link if a LICENSE file exists in the root directory of the repository. if no LICENSE file exists, then don't create the "license" nav link
- **documentation**: convert a lot of the stuff i (m455) made in the readme into an e2e tutorial
- **documenation**: scope the readme audience to folks who kind of know what they're doing with servers
- **feature** : if no README.md file exists in the root directory of the repository, then don't create the "about" nav link. instead, make the files page the index.html
- **feature**: add a "license" nav link if a LICENSE file exists in the root directory of the repository. if no LICENSE file exists, then don't create the "license" nav link
## hopes
- feature: clickable line numbers in source files
- feature: make repos with more files and directories less daunting (recursively generate a files list page for each directory in a repo?)
- feature: nav link: Releases
- **feature**: clickable line numbers in source files
- **feature**: make repos with more files and directories less daunting (recursively generate a files list page for each directory in a repo?)
- **feature**: nav link: Releases