Skip to content

This is a basic static site generator written in Rust

License

Notifications You must be signed in to change notification settings

Antonio-Bennett/rssg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

What is this project?

This is a simple Static Site Generator that converts txt files to html

Sample Site

Rssg Sample

To contribute view CONTRIBUTING

Features

Version

By using the -v or --version flag cargo r -- -v the user is able to see the version of rssg

Help

By using the -h or --help flag cargo r -- -h the user is able to see help information

Input

The program accepts inputs from the user using the -i or --input flag. Acceptable inputs are files and or folders

cargo r -- -i example.txt
cargo r -- -i example.md
cargo r -- -i exampleFolder/

Currently, the only working Markdown syntax is header1 "#".

Output

Output is stored in a current directory in folder named dist

Formated HTML

Paragraphs are outputted in a formatted and clean way

Title Substitution

By having the first line as title with 2 empty lines following. A title tag and h1 is generated automatically in the html output

Demo

Test File


A small sample size

Nothing major I just wnat to Test
how good this thing is working

Test test test test

is converted to

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Test File</title>
    <meta name="viewport" content="width=device-width, initial-scale=1" />
  </head>
  <body>
    <h1>Test File</h1>

    <p>A small sample size</p>

    <p>Nothing major I just wnat to Test how good this thing is working</p>

    <p>Test test test test</p>
  </body>
</html>

USAGE

Rust Static Site Generator - RSSG

USAGE:
  rssg [OPTIONS] [DIRECTORY/FILES]

  OPTIONS:
  -h, --help         Prints help information
  -v, --version      Prints rssg version
  -i, --input        Specifies input to be used - directory or files

About

This is a basic static site generator written in Rust

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages