OSD600- Siteit is not a citation tool

Siteit might sound like a tool that generates citations for you, but it is not.

What is Siteit?

Siteit is an open-source command-line tool that converts text files into HTML files.

Steps to Install

• Access Siteit on GitHub by clicking here.

• Use git to clone the repo to local machine.

• Navigate to the cloned directory using command-line and execute the following commands:
  

npm install

npm link

• Now test out the tool:

siteit -h

Using siteit with -h or --help option displays the usage manual. If an error message, is displayed instead try running siteit as follows:

node ./index.js -h

Running either siteit -h or node ./index.js should yield the following result:

SiteIt - USAGE MANUAL

    usage:   
             siteit [flag]
             siteit [flag] [source_file]
             siteit [flag] [source_directory]

    example: 
             siteit -v
             siteit -i source_file.txt
             siteit -i ./source_directory

Common SiteIt Flag Options
----------------------------------------------------------------------

    --version | -v     Outputs tool name and version information

    --help    | -h     Outputs Siteit command usage manual 

    --input   | -i    Accepts a source file or a directory containing 
                       files as input, and outputs an HTML file for 
                       each file supplied

----------------------------------------------------------------------
                        *** END OF MANUAL ***                   

• The --input option is the one that accepts a file or a directory containing .txt files as a parameter and converts them into static webpages. The generated files can be viewed in the application's dist directory. If the source is a directory, an index.html file will be available with links to all the newly generated HTML pages.

Click here to see the resulting static website.

More information on tool usage is available on GitHub.

PS

This is the first release of Siteit.
Stay tuned, as more features will be added in subsequent releases.