diff --git a/README.md b/README.md index db5c11e..64a44a0 100644 --- a/README.md +++ b/README.md @@ -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 `` 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