- Notifications
You must be signed in to change notification settings - Fork0
A simple static site generator based on commits from a git repository.
License
Lozul/glessite
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
A simple static site generator based on commits from a git repository.
The program expect to be launched within a git repository.If so, it will walk through the commit history and pick those whose title areprefixed byPOST:
.For every "post" found, an entry will be added to the index page, and a simpleHTML page will be generated using the title and the body (if present) of thecommit.
All the generated files will be stored in apublic
folder in the currentworking directory.
Glessite offers some options:
-r, --repository <REPOSITORY> Repository to use, default to current working dir, must be a valid path to a directory containing a .git-o, --output-dir <OUTPUT_DIR> Output directory, default to `public`-p, --prefix <PREFIX> Prefix to filter posts from normal commits, detault to `POST: `-n, --no-prefix If present, every commit will be used, prefix option is ignored
- Create a "post" commit
# Inside a git repositorygit commit --allow-empty -m "POST: Title" -m "Body of the post"
- Generate the site
glessite
- View the result by opening the generate web pages in a browser, for example
firefox public/index.html# orpython -m http.server --directory public
- Install Rust, this documentation assume that you have access to the
cargo
command
Withcrates.io
- Install the crate
cargo install glessite
- Download the repository and compile:
git clone https://github.com/Lozul/glessitecd glessitecargo build --release
- Install the crate
cargo install --path .
cargo uninstall glessite
This projet is under the MIT License.
The logo use the fontSource CodePro released under theSIL Open Font License 1.1.
Glessite is a type of natural resin, found it on thispage.The name started withG like Git and ended withsite, which fitted with theproject being a site generator.
About
A simple static site generator based on commits from a git repository.