stagit/README.md
2023-06-16 16:50:04 -04:00

37 lines
1.2 KiB
Markdown

# stagit
> static git page generator
## Information
This is my personal fork of [stagit](https://codemadness.org/stagit.html) which is running [git.acid.vegas](https://git.acid.vegas/)
## Dependencies
- C compiler *(C99)*
- libc *(tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl)*
- [libgit2](https://github.com/libgit2/libgit2) *(v0.22+)*
- [md4c](https://github.com/mity/md4c) *(v0.4.4+)*
- POSIX make *(optional)*
## Setup
```shell
cd stagit
make
sudo make install
```
###### New Features
- [X] Markdown rendering to HTML for README files
- [ ] Syntax hilighting
- [X] Repository categories
- [ ] Direct download to repository tar.gz
- [X] Style changes
- [ ] Raw file viewing
###### Fixes
- [ ] Clickable heading *(h1-h6)* links in README *(md4c does not FULLY transform markdown)*
- [ ] Top/bottom padding for multi-lined `<code>` blocks
- [ ] Missing image references in README files *(md4c does not look in /files/ for the .screens directory)*
###### Props
- Hiltjo Posthuma *(orignal author of [stagit](https://codemadness.org/git/stagit/))*
- Larry Burns *([stagit-md](https://github.com/lmburns/stagit-md))*
- Oscar Benedito *([md4c implementation](https://oscarbenedito.com/blog/2020/08/adding-about-pages-to-stagit/))*