cmd-ssg

deliverable 0.1 for OSD600 open source course at seneca

Description: command-line-static site tool#

  VERSION    : 0.1.0
  Use        : Process input .txt or .md files into generated .html files.

Prerequisite for development#

   "node": ">=16.9.1",
   "npm" : ">=7.23.0"

   if you are developing,
   run npm install

Screen Shot#

How to Use#

git clone <this repo>

npm install -g . or npm install if you are just testing

ssgy <command option>    or    ./bin/index.js <command option> to be safe

Example Use:
ssgy -i examples
ssgy -i <file/folder with .txt or .md files> -s <stylesheet.css>

# If you don't like typing commands use json file
ssgy -c config.json

FEATURES#

cmd-ssg
github repo created
MIT license chosen
create README.md - keep it updated as you write your code, documenting how to use your tool, which features you include, etc. Your README file should tell users how to use your tool.
choose Javascript/Node.js language
running the tool with --version or -v flag will print the tool's name and current version
running the tool with --help or -h flag should print standard help/usage message also showing how to run the tool, which command line flags and arguments can be used, etc.
specify input file or folder with --input or -i
generate one .html output file for each input file NOTE : the original txt files should not be modified
need to deal with marking-up paragraphs: every blank line should be considered a paragraph limit and the text transformed into < p>
your tool should place all output into a ./dist folder by default
input can be deep within the files such as .\test\test2\
parse a title from your input files
adding -s stylesheet option
making it easy on the eyes
proper error message if incorrect file/folder inputs
accept a json file to pass options from the file

Special Thanks  : Kevan Yang
Markdown Feature: Oliver Pham
Author          : Eugene Chung

License#

MIT