STOG is a static blog generator from a directory of markdown files.
WARNING: THIS PROJECT IS NOT STABLE YET!!
IMPORTANT: If you are using the nightly toolchain version 1.57.0 or older, you will need to update your toolchain to install this crate, see dtolnay/proc-macro2/issues/307.
For installation you will have two options:
- install from source code
- install from cargo
cargo install stog
- Clone the repository:
git clone https://github.com/zolagonano/stog.git
- Change your working directory to source code directory:
cd stog
- Compile and run:
cargo build --release
cargo run
stog init <blog_name>
- Edit
config.toml
to change basic settings. - Edit template files witch located at
_templates
. - Add your CSS/javascript files to the
public
directory and it will copy them to the build directory(Notice that you should change your templates to use your CSS and javascript.).
Run stog with build subcommand to build your directory(the result will be located at _build
):
stog build
Now you can take _build
directory and host it anywhere.
All contributions are welcome but if you don't know what you can do look at this list:
- Open an issue if you find a bug.
- Open an issue if you have a suggestion.
- Fix bugs and send pull requests.
- Share it with your friends.
- And anything else you think will help this project :).