26 releases

0.0.26 Mar 2, 2024
0.0.24 Feb 24, 2024
0.0.21 Dec 25, 2023
0.0.20 Nov 5, 2023
0.0.9 Mar 28, 2023

#369 in Parser implementations

Download history 10/week @ 2023-12-23 17/week @ 2024-01-13 34/week @ 2024-02-17 271/week @ 2024-02-24 207/week @ 2024-03-02 50/week @ 2024-03-09 13/week @ 2024-03-16 2/week @ 2024-03-23 13/week @ 2024-03-30

82 downloads per month

MIT/Apache

260KB
3.5K SLoC

Shokunin Static Site Generator (SSG)

The fastest Rust-based Static Site Generator (SSG) for building professional websites and blogs.

Logo of the Shokunin Static Site Generator

Part of the Mini Functions family of Rust libraries.

Banner of the Shokunin Static Site Generator

Made With Rust Crates.io Lib.rs Docs.rs License Codecov

WebsiteDocumentationReport BugRequest FeatureContributing Guidelines

divider

Overview

Shokunin is a lightning-fast static site generator (SSG) that is optimised for Search Engine Optimisation (SEO) and fully aligned with Accessibility Standards.

The library extracts metadata and content to generate static HTML files from Markdown, YAML, JSON, and TOML. It also supports HTML themes and custom templates to help you create high quality websites with ease.

Features

Shokunin Static Site Generator (SSG) feature highlights include:

  • Blazing fast and flexible static site generator written in Rust
  • Built-in support for GitHub Flavoured Markdown (GFM)
  • Built-in support for Google Analytics and Bing Analytics
  • Experimental support for PDF generation
  • Compatible with various HTML themes and premium templates
  • Generates Atom and RSS feeds for your blog posts automatically
  • Generates minified HTML for optimal performance and SEO
  • Includes a built-in Rust development server for local testing
  • Supports multiple content formats:
    • Markdown
    • YAML
    • JSON
    • TOML
    • XML
  • Built-in generation for:
    • Sitemaps
    • robots.txt
    • Canonical name (CNAME) records
    • Custom 404 pages
  • Comprehensive documentation

Table of Contents

Getting Started

It takes just a few minutes to get up and running with Shokunin Static Site Generator (SSG).

Installation

To install Shokunin Static Site Generator (SSG), 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 Static Site Generator (SSG) using the following command:

cargo install ssg

For simplicity, we have given Shokunin Static Site Generator (SSG) 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 and commands:

ssg --help

Requirements

The minimum supported Rust toolchain version is currently Rust 1.71.1 or later (stable). It is recommended that you install the latest stable version of Rust.

Platform support

Shokunin Static Site Generator (SSG) is supported and tested on the following platforms and architectures as part of our CI/CD pipeline.

The GitHub Actions shows the platforms in which the Shokunin Static Site Generator (SSG) library tests are run.

Documentation

ℹ️ Info: Please check out our website for more information. You can find our documentation on docs.rs, lib.rs and crates.io.

Usage

Command Line Interface (CLI)

The Shokunin Static Site Generator (SSG) library runs in a Terminal window and can be used to easily generate a static website. To get started, run:

ssg  --new=docs --content=content --template=template --output=output --serve=public

or

ssg  -n=docs -c=content -t=template -o=output -s=public

This creates a new website in a directory called docs using the markdown content from the content directory and the HTML templates from the template directory. The static and compiled HTML files and artefacts are then generated in a docs folder.

Shokunin is ideal for hosting your site on GitHub Pages. Simply commit and push the docs folder to your main branch, and set the GitHub Pages publishing source to point to that folder.

During development, you can use the --serve or --s option to start a local development server to preview content changes.

With Shokunin's GFM and theme support, you can focus on writing markdown content while the SSG handles delivering a fast, SEO-friendly site.

Arguments

  • -n, --new: The name of the folder for your new website. (required)
  • -c, --content: The directory containing the website markdown content. (required)
  • -t, --template: The directory containing the HTML website templates. (required)
  • -o, --output: The directory where the generated website files will be saved temporarily. (required)
  • -s, --serve: Run the development server. (optional). The directory from which the website will be served. (optional)

In your project

To use the Shokunin Static Site Generator (SSG) library in your project, add the following to your Cargo.toml file:

[dependencies]
shokunin = "0.0.26"

Add the following to your main.rs file:

extern crate ssg;
use ssg::*;

then you can use the Shokunin Static Site Generator (SSG) functions in your application code.

Examples

To get started with Shokunin Static Site Generator (SSG), 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.

cargo run --example example

The command will generate a static website based on the configuration details in the examples directory.

use ssg::compiler::compile;
use std::path::Path;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Define the paths to the build, site, content and template directories.
    let build_path = Path::new("examples/example.com/build");
    let content_path = Path::new("examples/example.com/content");
    let site_path = Path::new("examples/example.com/public");
    let template_path = Path::new("examples/example.com/template");

    compile(build_path, content_path, site_path, template_path)?;

    Ok(())
}

The main() function in this code compiles a website from the content directory, using the template directory to generate the website files. The compiled website is saved in the build directory and served directly from the example.com directory.

Args

  • build_path: The path to the directory where the compiled website will be saved.
  • content_path: The path to the directory containing the website content.
  • site_path: The path to the directory where the generated website files will be served from.
  • template_path: The path to the directory containing the website templates.

Semantic Versioning Policy

For transparency into our release cycle and in striving to maintain backward compatibility, Shokunin Static Site Generator (SSG) follows semantic versioning.

License

The project is licensed under the terms of both the MIT license and the Apache License (Version 2.0).

Contribution

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.

Acknowledgements

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.

Dependencies

~45–64MB
~1M SLoC