DEV Community

anshul137
anshul137

Posted on

DPS909 Blog :Static Site Generator (ag-ssg) Release 0.1

Hey everyone, thanks for reading my Blog post in our first Assignment Release 0.1, we were asked to make the Static Site Generator. I named it (ag-ssg).

Link to repository : ag-ssg.

Overview

In this project we were supposed to create the tool which can convert the .txt file type to .html file type. In this version of our project, User can use the command line tool to specify the particular text file or particular folder which contains multiple text files to convert all of them to .html files.

Outline

In this release version user can do the following

  1. User can use the command line tool to specify the particular .txt file to convert it into .html file type.
  2. User can specify the folder which contains multiple .txt files to convert all of them into a separate .html file type.

Requirements

  • This tool is built using the Node.js

Steps to Run this project

  • Clone the repository into your local drive
 git clone  <repository url> <project_name>
Enter fullscreen mode Exit fullscreen mode
  • Install all the dependencies
cd <project_name>
npm install
Enter fullscreen mode Exit fullscreen mode
  • Run the npm link module
npm link
Enter fullscreen mode Exit fullscreen mode
  • Build and run the project
node app.js - <command line arguments>
Enter fullscreen mode Exit fullscreen mode

Example

  • if the file is in particular folder we have to provide the path like this node app.js -i "./textfile/Silver Blaze.txt".
  • if you want to convert the whole folder text file to .html use this commnad node app.js -i textfile

Test example

  • Output

Output

Command line options

Command line option available for User in this tool

Option Detailed Inforamtion
-v, --version Print the tool's name and current version
-i, --input file Allow users to specify the file
-h, --help Prints information about usage of tool

.txt file for testing

Folder in directory named textFile contains all the text file which i have used to test my code.
One extra file is available in the main directory named "test.txt".

Running the Tool with different commands

Command type Description
node app.js -i <.txt file> Create single .html file
node app.js -i <folder> Create all the .txt file to .html which are available in the folder

Optional Feature

In addition to the above feature i have implemented these feature in my site.

  • Improve the look and feel of your generated HTML pages using a default stylesheet that you design.

  • if the user specifies a folder for the input, automatically generate an index.html file, which has relative links to each of the generated HTML files.

Top comments (0)