1.1.2 • Published 2 years ago
create-ssg v1.1.2
SUHHEE_SSG_OSD-release0.1
This is an HTML generator from the text file to HTML.
Download by NPM
- Download npm package -> npm i -g create-ssg
- Create folder name "docs"
- 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
- Download or clone the code.
- Download node, if you don't have it.
- Add environment variable on your laptop(C:\Program Files\nodejs)
- Open the codes.
- Locate yourself to where package.json is located.
- Open cmd, type npm I, and wait for download.
- NPM link on cmd
Main Features
- Run by Commands, such as help, version, and input(Please look at the HElP for details!)
- It will convert your text file to a Static HTML file with some styles!
- It will convert markdown (.md) file to HTML file with style as well
Optional Features
- It has built-in Fancy-styled CSS!
- Also able to add your external CSS with the command -styledInput(-s) with link(Details and example are in HELP!)
Help:
- create-ssg --version(-v) : it will show you application name and version
ex.
$ create-ssg --version
$ create-ssg -v
- 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
- 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]
- create-ssg --styledInput filename/foldername (-s filename/foldername): 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>
- 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