SSS-rs (Skill, Slick, Style) is a library and CLI tool for creating stylish developer cards.

Available languages README

RU | EN

Library

Core Components

1. Configuration (sss-core)

   • Data structures for developer information

2. Themes (render, trait Shade or structure Theme)

   • Customizable color schemes
   • Built-in themes:
     • Umbrella (default)
     • Rosé Pine
     • GrooveBox
     • Dracula

3. Layouts (render, trait Layout)

   • Tera-based templating system
   • HTML and TailwindCSS* support
   • Responsive design

Library Usage

use sss_core::Settings;
use sss_std::prelude::{Themes, HtmlLayouts};

// Create configuration
let settings = Settings::default();

// Choose theme and layout
let theme = Themes::Umbrella;
let layout = HtmlLayouts::Umbrella;

// Generate HTML
let html = layout.finalize(&settings, &theme.into())
    .render()
    .unwrap();

SSS-rs CLI

CLI tool for generating HTML/PNG/PDF using SSS-rs themes and layouts. Allows you to host generated pages with hot reload for themes and layouts.

Dependencies

• PNG/PDF
  • chromium/chrome (headless_chrome mode)
    • If you don't have it, these features won't work, but everything else will.

Usage

sss_cli [OPTIONS] <COMMAND>

Global Options

• -c, --config <PATH> - path to config file (default: config.toml)
• -t, --theme <THEME> - theme selection [possible values: umbrella, rose-pine, groove-box, dracula]
• -l, --layout <LAYOUT> - layout selection [possible values: umbrella, castle, github]
• -o, --out <FILE> - output HTML filename (default: sss-rs.html)
• --tracing <TRACING> - Log level [default: info] [possible values: info, trace, debug, error, warn]
• -h, --help - print help
• -V, --version - print version

Commands

new - Generate new config

sss_cli new [OPTIONS]

Options:
  -t, --type <TYPE>    Configuration format [default: toml]
                              [possible values: json, toml]

run - Start development server

sss_cli run [OPTIONS]

Options:
  -w, --watch               Watch for config changes
  -s, --serve               Start web server
  -a, --address <ADDRESS>   Web server address [default: 0.0.0.0:8081]
  --html                    launch html service [default]
  --png                     launch png generator service
  --pdf                     launch pdf generator service
  --json                    launch json converter for settings service
  --health                  launch healf checker service
  --share                   launch base64 service
  --api                     launch rapidoc api service

Avaiable routes

• Api doc
  • Scalar API Page: /api
• Routes
  • Main card (html) page: /
  • Png card: /png
  • Pdf card: /pdf
  • Json settings of instance: /json
  • Base64 toml config : /share
  • Health check : /health

gen - Generate HTML, PNG, PDF

sss_cli gen [OPTIONS]

Options:
  -t, --type <OUTPUT_TYPE>  output type [default: html] [possible values: html, png, pdf]
  -o, --out <OUTPUT_NAME>   output name [default: sss-rs]

Usage Examples

# Create new TOML configuration
sss_cli new
# or
# Create JSON configuration
sss_cli new --config-type json

# Start development server with auto-reload
sss_cli run --watch --serve
# or (html by default)
sss_cli run -w -s
# run with html, png, json and api routes
sss_cli run -w -s --html --png --json --api

# Additional options

# Generate HTML with custom output file
sss_cli -o portfolio.html gen

# Commands below disable hot reload for applied value
# Generate HTML with theme
sss_cli -t dracula gen

# Generate HTML with layout
sss_cli -l github gen

How to build CLI

git clone https://github.com/TOwInOK/SSS-rs
cd SSS-rs
cargo build -r -p sss_rs
mv target/release/sss_cli sss-cli
./sss-cli

How to run file downloaded from github on macos

xattr -rd com.apple.quarantine name_of_file
./name_of_file

SSS-rs Web App

How to start locally?

you need to install trunk, then run

cd sss-web-app
trunk serve --open

This command will start the server on port 3000 and open your default browser.

How to build your own layout

Guide

• SSS cli
  • At the moment you can't use your own templates directly with cli. You can make an Issue for adding them.
• SSS-lib
  • You can create and use your own templates with HtmlTeraRender or Create your own implementation with traits: Layout + Finalise

License

Apache 2.0

Contributing

If you want to add a new theme or layout, create an Issue!

Card example

SSS-rs editor