#blog #static #markdown #minimal #generator

bin+lib stog

STOG is a static blog generator implemented in rust

3 unstable releases

0.2.0 Aug 12, 2022
0.1.1 Jul 3, 2022
0.1.0 Apr 4, 2021

#21 in #minimal

MIT license

180KB
336 lines

STOG

b b b

STOG is a static blog generator from a directory of markdown files.

WARNING: THIS PROJECT IS NOT STABLE YET!!

Installation:

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:

  1. install from source code
  2. install from cargo

From cargo:

cargo install stog

From the source code:

  1. Clone the repository:
git clone https://github.com/zolagonano/stog.git
  1. Change your working directory to source code directory:
cd stog
  1. Compile and run:
cargo build --release
cargo run

Usage:

Create new blog:

stog init <blog_name>

Customize your blog:

  • 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.).

Build your blog:

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.

Screenshots:

screenshot

Contribute:

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 :).

Dependencies

~10–20MB
~266K SLoC