A Fast and Flexible Static Site Generator written in Rust.
Website β’ Documentation β’ Report Bug β’ Request Feature β’ Contributing Guidelines
Shokunin (θ·δΊΊ) is a fast and flexible static site generator (ssg) written in Rust. It aims to provide an easy-to-use and powerful tool for building static websites.
It takes just a few minutes to get up and running with shokunin.
To install shokunin, you need to have the Rust toolchain installed on
your machine. You can install the Rust toolchain by following the
instructions on the Rust website.
Once you have the Rust toolchain installed, you can install shokunin
using the following command:
shell
cargo install ssg
For simplicity, we have given shokunin a simple alias ssg which can
stand for Shokunin Site Generator or Static Site Generator.
You can then run the help command to see the available options:
shell
ssg --help
The minimum supported Rust toolchain version is currently Rust 1.68.0 or later (stable).
shokunin is supported and tested on the following platforms:
| Target | Description | Status | | --- | --- | --- | | aarch64-unknown-linux-gnu | 64-bit Linux systems on ARM architecture | β | | aarch64-unknown-linux-musl | 64-bit Linux systems on ARM architecture | β | | arm-unknown-linux-gnueabi | ARMv6 Linux (kernel 3.2, glibc 2.17) | β | | armv7-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) | β | | i686-unknown-linux-gnu | 32-bit Linux (kernel 3.2+, glibc 2.17+) | β | | i686-unknown-linux-musl | 32-bit Linux (kernel 3.2+, musl libc) | β | | x8664-unknown-linux-gnu | 64-bit Linux (kernel 2.6.32+, glibc 2.11+) | β | | x8664-unknown-linux-musl | 64-bit Linux (kernel 2.6.32+, musl libc) | β |
| Target | Description | Status | | --- | --- | --- | | x86_64-apple-darwin | 64-bit macOS (10.7 Lion or later) | β |
The GitHub Actions shows the platforms in which the shokunin
library tests are run.
βΉοΈ Info: Please check out our website for more information. You can find our documentation on docs.rs, lib.rs and crates.io.
To use the shokunin library in your project, add the following to your
Cargo.toml file:
toml
[dependencies]
shokunin = "0.0.4"
Add the following to your main.rs file:
rust
extern crate ssg;
use ssg::*;
then you can use the functions in your application code.
To get started with shokunin, you can use the examples provided in the
examples directory of the project.
To run the examples, clone the repository and run the following command in your terminal from the project root directory.
shell
cargo run --example example
For transparency into our release cycle and in striving to maintain
backward compatibility, shokunin follows semantic versioning.
The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).
We welcome all people who want to contribute. Please see the contributing instructions for more information.
Contributions in any form (issues, pull requests, etc.) to this project must adhere to the Rust's Code of Conduct.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
A big thank you to all the awesome contributors of shokunin for their help and support.
A special thank you goes to the Rust Reddit community for providing a lot of useful suggestions on how to improve this project.