Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aecio/sitegen
Yet another simple static site generator... that works.
https://github.com/aecio/sitegen
sitegen static-site-generator
Last synced: 11 days ago
JSON representation
Yet another simple static site generator... that works.
- Host: GitHub
- URL: https://github.com/aecio/sitegen
- Owner: aecio
- Created: 2016-06-09T05:16:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-20T04:01:24.000Z (almost 2 years ago)
- Last Synced: 2023-03-11T16:25:58.416Z (almost 2 years ago)
- Topics: sitegen, static-site-generator
- Language: Java
- Size: 179 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
Awesome Lists containing this project
README
# SiteGen
Yet another simple static site generator... that works.
## Install
To build sitegen from source, you can run the following commands in your terminal:
```bash
git clone https://github.com/aecio/sitegen.git
cd sitegen
./gradlew clean installDist
```
which will generate an installation package under sitegen/build/install/. You can then make SiteGen command line available in the terminal by adding it to the PATH:
```bash
export SITEGEN_HOME="{path-to-cloned-sitegen-repository}/build/install/sitegen"
export PATH="$SITEGEN_HOME/bin:$PATH"
```
## Usage
Files should be created using the following convention:
```c
.
└── src
│ ├── pages // create your pages here
│ │ ├── index.html
│ │ ├── page1.html
│ ├── static // any static assets goes here
│ │ ├.. any-file.pdf
│ │ ├── css
│ │ │ └── style.css
│ │ ├── img
│ │ │ └── logo.jpg
│ └── templates // templates for your pages goes here
│ └── mytemplate.mustache
└── output // Website will be generated here.
│.. index.html
│.. page1.html
└── static // Static folder will be copied here
```
Then, run `sitegen` on the root directory of your project. `sitegen` is going to compile the web site and run a web server. Navigate to [http://localhost:8080](http://localhost:8080) to view the result. If you change any file while the web server
is running, then the changes will be detected automatically and the web site
will recompiled.
## Templates
Currently, the following template engines are supported:
- Mustache
- Markdown
- Freemaker