Skip to content

cychu42/siteit

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Siteit

About

Siteit allows users to convert text files into .html pages. Presently, Siteit only supports input files with .txt format.

Installation

  • Use the command git clone to clone the repo to your local machine
  • cd into the cloned directory, and run npm install to install all the dependencies
  • Run npm link to run Siteit locally on your machine

Usage

Command Option/Flag Additional Argument(s) Description
siteit -v or --version n/a Displays tool name and version information
siteit -h or --help n/a Display usage manual
siteit -i or --input ./filename.txt Converts the content of the file supplied as additional argument into an .html document. To locate the generated file, cd into application's dist directory
siteit -i or --input ./directory Yet to be implemented

Usage format: siteit [option/flag] [additional arguments]

If you are on Windows and are unable to run the tool using the aforementioned usage format, follow these steps:

Recommended Approach

  • Use node command prefix to run the app as follows:
    • node ./index.js -h

Not Recommended Approach

  • Using PowerShell in Admin Mode, run the following command to bypass PowerShell's Execution Policy
    • For temporary bypass run: Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
    • For permanent bypass (not recommended) run: Set-ExecutionPolicy -Scope LocalMachine -ExecutionPolicy Unrestricted

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%