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

154 lines
5.3 KiB
Markdown
Raw Normal View History

first commit
2022-12-02 16:41:55 -05:00
# repo2html
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
A command-line tool that generates a static HTML representation of a Git
repository.
feature: license nav link, optional about nav link
2022-12-09 02:15:03 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
## Page contents
feature: license nav link, optional about nav link
2022-12-09 02:15:03 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
<!-- vim-markdown-toc GFM -->
feature: license nav link, optional about nav link
2022-12-09 02:15:03 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
- [Features](#features)
- [Requirements](#requirements)
- [Usage](#usage)
- [Installation](#installation)
- [Configuration](#configuration)
- [Templates](#templates)
- [Environment variables](#environment-variables)
small wording edit
2022-12-20 01:22:38 -05:00
- [Creating a Git forge on your web server](#creating-a-git-forge-on-your-web-server)
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
- [Alternative Git-to-HTML tools](#alternative-git-to-html-tools)
- [Existing Git forges](#existing-git-forges)
- [Existing Git forge software](#existing-git-forge-software)
- [Todos](#todos)
feature: license nav link, optional about nav link
2022-12-09 02:15:03 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
<!-- vim-markdown-toc -->
check file existence in source-files-list not cwd added source-files-list to populate-html-template. kindof dislike having so many variables passed to a function but i also kindof dislike global variables; not sure how to make this prettier yet. but this solves the bug i introduced in my last commit where the nav links were broken when used as a githook.
2022-12-09 11:00:07 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
## Features
first commit
2022-12-02 16:41:55 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
- Static html files
- Customizable templates
- Can be used as a standalone command-line tool, or in a Git hook
- Built-in, plaintext issue support
- Image support
- Markdown files are rendered as HTML
- No resident background process
first commit
2022-12-02 16:41:55 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
## Requirements
first commit
2022-12-02 16:41:55 -05:00
fixed a small nit in the requirements
2022-12-20 01:11:36 -05:00
- [Chicken Scheme](https://call-cc.org/)
- The following Chicken Scheme eggs:
fix md formatting for nested uls
2022-12-09 11:00:08 -05:00
- [clojurian](https://wiki.call-cc.org/eggref/5/clojurian)
enable customizable jinja-like templates via ersatz! well this was a journey :) behavior when running `repo2html <output directory>` remains the same; we apply our internal sxml template as usual. to use ersatz templates, run like this: `repo2html <output directory> <template directory>` the program will look for a "default.html" file in that directory.
2022-12-16 12:28:55 -05:00
- [ersatz](https://wiki.call-cc.org/eggref/5/ersatz)
- [lowdown](https://wiki.call-cc.org/eggref/5/lowdown)
added new dependencies to readme and makefile
2022-12-13 17:02:01 -05:00
- [scss](https://wiki.call-cc.org/eggref/5/scss)
- [srfi-1](https://wiki.call-cc.org/eggref/5/srfi-1)
- [srfi-13](https://wiki.call-cc.org/eggref/5/srfi-13)
- [srfi-14](https://wiki.call-cc.org/eggref/5/srfi-14)
enable customizable jinja-like templates via ersatz! well this was a journey :) behavior when running `repo2html <output directory>` remains the same; we apply our internal sxml template as usual. to use ersatz templates, run like this: `repo2html <output directory> <template directory>` the program will look for a "default.html" file in that directory.
2022-12-16 12:28:55 -05:00
- [sxml-transforms](https://wiki.call-cc.org/eggref/5/sxml-transforms)
- [symbol-utils](https://wiki.call-cc.org/eggref/5/symbol-utils)
- [utf8](https://wiki.call-cc.org/eggref/5/utf8)
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
- Git
## Usage
repo2html <destination> <template-directory>
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
Run `repo2html` inside the root directory of a Git repository or a bare Git
repository.
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
- `<destination>` is the path to the directory that you want the HTML files to
be generated in.
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
- `<template-directory>` is the path to the directory that contains a
`default.html` file. Refer to `assets/templates/default.html` for an example
`default.html` file.
The HTML that's generated represents the state of the `HEAD` commit, not the
current state of the work tree.
## Installation
This section guides you through installing the required dependencies, compiling
a binary, and then installing the binary. By default, `repo2html` installs
into the `/usr/local/bin` directory.
1. Ensure you're in the `repo2html` git repository.
2. As root, run `make dependencies` to install the required Chicken Scheme eggs.
3. Run `make` to compile a static `repo2html` binary in the current directory.
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
4. As root, run `make install` to copy the `repo2html` binary into the
`/usr/local/bin` directory.
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
**Note**: If you want to use `main.scm` as the `repo2html` executable, instead
of compiling a static binary file, then run
`cp main.scm /usr/local/bin/repo2html` as root.
## Configuration
You can `repo2html` by changing the following items:
- [Templates](#templates)
- [Environment variables](#environment-variables)
docs: updated requirements
2022-12-02 16:54:38 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
### Templates
added a quickstart
2022-12-08 21:20:04 -05:00
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
You can customize `repo2html` by editing the `assets/templates/default.html`,
and then specifying the path to the `default.html` file as the second
command-line argument when running `repo2html`.
added a quickstart
2022-12-08 21:20:04 -05:00
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
For example, if you placed a `default.html` file in `~/bin`, and you serve HTML
files from `/var/www/git`, then you run `repo2html /var/www/git ~/bin`.
added a quickstart
2022-12-08 21:20:04 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
### Environment variables
quick notes and updates added to readme, minor makefile changes
2022-12-07 15:18:27 -05:00
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
You can provide a generic description by setting the `REPO2HTML_DESCRIPTION`
environment variable, or by adding a description in a `description` file in the
root directory of your Git repository.
first commit
2022-12-02 16:41:55 -05:00
small wording edit
2022-12-20 01:22:38 -05:00
## Creating a Git forge on your web server
removed some out-of-scope sections
2022-12-06 00:07:43 -05:00
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
Refer to
hmm it doesn't work again lol
2022-12-20 01:27:22 -05:00
[Create a Git forge with repo2html](html/documentation/create-a-git-forge-with-repo2html.md.html)
small wording edit
2022-12-20 01:22:38 -05:00
to learn how use `repo2html` in a `post-receive` hook to auto-generate HTML
representations of bare Git repositories on a remote web server after you `git
push` to them.
removed some out-of-scope sections
2022-12-06 00:07:43 -05:00
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
## Alternative Git-to-HTML tools
- [stagit](https://codemadness.org/git/stagit/file/README.html)
- [depp](https://git.8pit.net/depp.git/)
- [git-arr](https://blitiri.com.ar/p/git-arr/)
## Existing Git forges
- [NotABug](https://notabug.org/)
- [Codeberg](https://codeberg.org/)
- [sourcehut](https://sourcehut.org/)
- [GitLab](https://gitlab.com/)
- [Bitbucket](https://bitbucket.org/product/)
- [SourceForge](https://sourceforge.net/)
- [GitHub](https://github.com/)
## Existing Git forge software
more typos fixed
2022-12-20 01:01:32 -05:00
- [GitLab](https://about.gitlab.com/install/)
- [Gogs](https://gogs.io/)
- [Gitea](https://gitea.io/)
- [cgit](https://git.zx2c4.com/cgit/)
- [GitWeb](https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb)
- [legit](https://git.icyphox.sh/legit)
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
## Todos
first commit
2022-12-02 16:41:55 -05:00
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
- **documentation/feature**: use post-update rather than post-receive hook for
simplicity
simplify main readme by moving "git forge" specifics elsewhere just a suggestion; don't feel obligated to merge. you know technical writing and documentation better than i do!
2022-12-09 11:52:38 -05:00
- **documentation**: also describe use with post-commit hook
Updated documentation and cleaned up directory tree - Updated documentation, so it's very nice for pho4cexa <3 - Moved helper/example files to an assets directory (feel free to rearrange all of these again if you have any better ideas :D - Renamed and moved tutorial file to make it more descriptive - Removed old environment variables from post-receive hook example file
2022-12-20 00:42:35 -05:00
- **documentation**: describe readme, license, and issues behaviours
simplify main readme by moving "git forge" specifics elsewhere just a suggestion; don't feel obligated to merge. you know technical writing and documentation better than i do!
2022-12-09 11:52:38 -05:00
- **feature**: multi-page or collapse-able files list
- **feature**: branches and releases (tags)
made todos and hopes types more distinguishable from the proceeding phrase
2022-12-08 21:01:31 -05:00
- **feature**: clickable line numbers in source files
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
- **feature**: display binary files as output from binary-file analysis tools
like `hexdump`, `xxd`, `dumpelf`, `elfls`, `readelf`, etc.?
simplify main readme by moving "git forge" specifics elsewhere just a suggestion; don't feel obligated to merge. you know technical writing and documentation better than i do!
2022-12-09 11:52:38 -05:00
- **feature**: syntax highlighting?
a little footer
2022-12-12 00:31:32 -05:00
- **feature**: markdown-render git log text
prefixed 'html/' to tutorial link. fixed line lengths
2022-12-20 01:05:34 -05:00
- **feature**: other mechanisms for header id application like uniqueness
checking, sequential numbering
feature: license nav link, optional about nav link
2022-12-09 02:15:03 -05:00
Reference in a new issue Copy permalink