Skip to content

Latest commit

 

History

History
62 lines (45 loc) · 3.4 KB

README.md

File metadata and controls

62 lines (45 loc) · 3.4 KB
Raw

OpenSSG

OpenSSG is a static site generator to grep all text and markdown files in a designated folder, and generate matching HTML files in a separate folder.

And index.html file will be created to link all your generated html files. Each page also will have the auto-configured sidebar to navigate pages easily. Your text file will turn into complete website! You can also specify output folder, and it will generate html files in the same hierarchy from original folder. You can specify CSS files to add too.

To Use OpenSSG

  • Go to https://search.maven.org/ and search open-ssg. Download the latest version and run java -jar open-ssg-0.9.9.jar with option.
  • Or go to https://repo1.maven.org/maven2/io/github/genne23v/open-ssg/ and download the latest jar file. Run java -jar open-ssg-0.9.9.jar with option.
  • Before running jar file, make sure that JDK is installed in your machine. Download HERE. 18.0.2.1 is used in OpenSSG.
  • To contribute, please check out CONTRIBUTING.md document.

Usage

Run java OpenSSG -v or java OpenSSG --version to check program information

Run java OpenSSG -h or java OpenSSG --help to find the usage and how to use options

java OpenSSG -i <FILE OR FOLDER> or java OpenSSG --input <FILE OR FOLDER> will generate .html file in ./dist folder. If you specify a folder name, it will find all txt files and generate matching .html files in the same hierarchy to original folder. Quotes should be surrounded at the beginning and end of the file or folder name to avoid argument error.

java OpenSSG -o <FOLDER NAME> or java OpenSSG --output <FOLDER NAME> will override default folder and create a new folder to generate HTML files. If you want to add spaces in folder name, folder name should be surrounded by quotation marks.

java OpenSSG -s <CSS LINK1> <CSS LINK2>... or java OpenSSG --stylesheet <CSS LINK1> <CSS LINK2>... will add CSS files to each HTML file's head. Multiple CSS file links can be added to the command.

java OpenSSG -l <LANGUAGE> or java OpenSSG --lang <LANGUAGE> will update the default <html lang="en"> to specified lang option.

Config File

You can specify a -c or --config flag with a JSON file passed as an argument like -c test.json and it will search the JSON file for appropriate values such as stylesheets array or lang flag to change the nature of the program's operation. An example valid JSON would look like so:

{
    "input": "Silver Blaze.txt",
    "lang": "fr",
    "stylesheets": ["https://cdnjs.cloudflare.com/ajax/libs/tufte-css/1.8.0/tufte.min.css",
    "https://cdn.jsdelivr.net/npm/water.css@2/out/water.css"],
    "This":"Blah",
    "output": "NewWorkingHTML"
}

In this example multiple styles will be taken out of stylesheets and used, also "This" will be ignored.

Note that keys in the json are case sensitive. input lang stylesheets and output will work.

Generated Sample Site

https://genne23v.github.io/sherlock-homes-selected-stories/

Release

Version Date
0.9.9 Jan, 2, 2023
0.9.0 Nov, 26, 2022
0.4.0 Oct, 26, 2022
0.3.0 Oct, 7, 2022
0.2.0 Sep, 22, 2022
0.1.2 Sep, 18, 2022
0.1.1 Sep, 16, 2022
0.1.0 Sep, 11, 2022

License

Eclipse Public License 2.0 Refer to the License Document