seneca-cdot / siteit

Easy-to-use Static Site Generator that can turn `.txt` files into HTML.

Siteit

About

Siteit allows users to convert text files into .html pages. Presently, Siteit only supports input files in .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

Features

Siteit comes with its built-in stylesheet and supports various screen resolutions. When a folder with .txt files is supplied, an Index file is also generated in the dist folder, linking to all generated files.

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 file's content supplied as an additional argument into a .html document. To locate the generated file, cd into the application's dist directory
siteit	-i or --input	./directory	Converts all the files within a directory supplied as additional argument into .html documents. To locate the generated files, cd into the application's dist directory and open index.html

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

If the user is 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.