dodo-SSG

This Static Site Generator (SSG) command-line tool generates html files from txt and markdown (.md) files.

A single txt file or a folder containing txt files can be used as input. All the html files will be created inside a new ./dist folder.

The fist line of the text will be used as the html title and will be placed inside of a <h1> tag. Users can specify a CSS stylesheet using the option -s or --stylesheet

Prerequisites

Requirements to run this tool:

NodeJS

Installing

Clone the repository
cd into the folder
run npm install
run npm link

Usage

dodo-SSG --input file.txt
dodo-SSG --input file.md
dodo-SSG -i ./folder-name
dodo-SSG -i folder-name -s [CSS Stylesheet URL]

Example Input

Dodo-Facts.txt

DODO Facts


The dodo (Raphus cucullatus) is an extinct flightless bird that was endemic to
the island of Mauritius, east of Madagascar in the Indian Ocean.

The first recorded mention of the dodo was by Dutch sailors in 1598.

Example Output

./dist/Dodo-Facts.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>DODO Facts</title>
    <meta name="viewport" content="width=device-width, initial-scale=1" />
  </head>
  <body>
    <h1>DODO Facts</h1>

    <p>
      The dodo (Raphus cucullatus) is an extinct flightless bird that was
      endemic to the island of Mauritius, east of Madagascar in the Indian
      Ocean.
    </p>

    <p>The first recorded mention of the dodo was by Dutch sailors in 1598.</p>
  </body>
</html>

Built With

Yargs - Used for command line arguments

Author

Francesco Menghi - Profile

License

This project is licensed under the MIT License

dbelokon / dodo-SSG