SUHHEE_SSG_OSD-release0.1

This is an HTML generator from the text file to HTML.

Download by NPM

1. Download npm package -> npm i -g create-ssg
2. Create folder name "docs"
3. Put all the files and folders that you want to convert to HTML

If you want to clone from gitHub

• Before Use You need to do

1. Download or clone the code.
   
2. Download node, if you don't have it.
   
3. Add environment variable on your laptop(C:\Program Files\nodejs)
   
4. Open the codes.
   
5. Locate yourself to where package.json is located.
   
6. Open cmd, type npm I, and wait for download.
   
7. NPM link on cmd

Main Features

1. Run by Commands, such as help, version, and input(Please look at the HElP for details!)
2. It will convert your text file to a Static HTML file with some styles!
3. It will convert markdown (.md) file to HTML file with style as well

Optional Features

1. It has built-in Fancy-styled CSS!
2. Also able to add your external CSS with the command -styledInput(-s) with link(Details and example are in HELP!)

Help:

1. create-ssg --version(-v) :
   it will show you application name and version
   

  ex.
  $ create-ssg  --version
  $ create-ssg  -v 

2. create-ssg --help(-h) :
   it will give you all the instructions that you need to use this application.
   

 ex.
 $ create-ssg  --help
 $ create-ssg  -h 

3. create-ssg --input [filename/foldername](-i [filename/foldername]) :
   it will automatically create a website for you using a file that you put in the command line
   or if you put folder name then it will automatically get all the txt files from the folder and create a website for you.
   

  ex.
  $ create-ssg  --input [filename/foldername]
  $ create-ssg  -i[filename/foldername] 

4. create-ssg --styledInput [filename/foldername] [external css link] (-s [filename/foldername] [external css link]):
   it will automatically generate website \n \t with beautiful external CSS"

  ex.
  $ create-ssg  --steyledInput [filename/foldername] [external css link]<br>
  $ create-ssg  -s [filename/foldername] [external css link]<br>

5. create-ssg --config [filename] :
   it will take the string data for input file and stylesheet URL and run it through SSG.

  ex.
  $ create-ssg  --config ssg-config.json

Technology used

• Node.js

License Used

• MIT License

Created by

• Suhhee Kim

Github Repo

• https://github.com/suhhee1011/suhheeKim_OSD_release0.1_create_ssg