Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.1 KB

README.md

File metadata and controls

68 lines (53 loc) · 2.1 KB
Raw

SUHHEE_SSG_OSD-release0.1

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

Technology used

  • Node.js

License Used

  • MIT License

Created by

  • Suhhee Kim

Github Repo

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.

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!

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
  1. 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
  1. 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]
  1. 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>