Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 1.59 KB

README.md

File metadata and controls

67 lines (51 loc) · 1.59 KB
Raw

ssgApplication

Implemented using Java to generate a static html site from a txt file.

Features

argument option "-v" or "--version" will display the current version of the application

argument option "-h" or "--help" will display the list of command options

argument option "-i" or "--i" will allow user input the single file or files by passing the directory. It supports both .txt and .md (feature: Heading)

Prerequisites

java

##Installation

  1. Clone this repository
  2. Locate the ssgApplication.jar

Run

  1. open command line
  2. run .jar file using java -jar with the argument
java -jar out\artifacts\ssgApplication_jar\ssgApplication.jar -i <txtFileName>

Output

You can find the generated outputs at \dist

Demo

java -jar out\artifacts\ssgApplication_jar\ssgApplication.jar --version
ssgApplication ver 1.0.0
java -jar out\artifacts\ssgApplication_jar\ssgApplication.jar -h <or --help>
---------------------------------------
* -v OR --version - current version   *
* -i OR --input - input file or files *
---------------------------------------
java -jar out\artifacts\ssgApplication_jar\ssgApplication.jar -i sources\Sherlock-Holmes-Selected-Stories
>Silver Blaze.html has been created in dist!
>The Adventure of the Six Napoleans.html has been created in dist!
>The Adventure of the Speckled Band.html has been created in dist!
>The Naval Treaty.html has been created in dist!
>The Red Headed League.html has been created in dist!

##License MIT

##Deployment version 1.0.0, Sept 2021 by author Irene Park