❤
npm
Sign UpSign In

text-ssg

1.0.3 • Public • Published

Welcome to Text SSG 👋

Static Site Generator in CLI that convert .txt and .md files into .html files

Install

  1. Install package

     npm install -g text-ssg@latest

Features

  • Supports stylesheets. By passing a url of stylesheet to -s or --stylesheet, if not specified it will use a default stylesheet (See usage).
  • Supports titles. If the first line is followed by two blank lines, it will populate the <title>...</title> and <h1>...</h1>.
  • Supports specific output. By passing an existing folder to -o or --output, if not specified it will generate to dist folder (See usage).
  • Supports deep tree of files and folders. If the user specifies a folder for --input or -i
  • Generate a menu page index.html which has relative links to each of the generated HTML files.
  • New paragraph is separated by a line.
  • Supports language code for HTML tag lang attribute. By passing a language code to -l or --lang, if not specified it will use a default lang (See usage).
  • Markdown support: headings, horizontal line, inline italic or bold texts, links with or without title
  • Configuration support: User can specify multiple configuration in one json file and pass the file with -c or --config.

Usage

ssg --input <path>

ssg --input <path> --output <path>

ssg --input <path> --output <path> --stylesheet <URL>

ssg --input <path> --output <path> --stylesheet <URL> --lang <languageCode>

ssg -i <path> -o <path> -s <URL> -l <languageCode>

ssg -c <path> -i <path>

Commands Supported

  _____                 _                 ____    ____     ____
 |_   _|   ___  __  __ | |_              / ___|  / ___|   / ___|
   | |    / _ \ \ \/ / | __|    _____    \___ \  \___ \  | |  _
   | |   |  __/  >  <  | |_    |_____|    ___) |  ___) | | |_| |
   |_|    \___| /_/\_\  \__|             |____/  |____/   \____|

Options:
    -v, --version     Show version number                [boolean]
    -h, --help        Show help                             [boolean]
    -i, --input       Folder/File input location            [string] [required]
    -s, --stylesheet  URL to a CSS stylesheet              [string]
    -o, --output      Folder output location          [string] [default: "./dist"]
    -l, --lang        HTML lang tag                    [string] [default: "en-CA"]
    -c, --config      Folder/File configuration JSON file location        [string]

Example

Input file: test.txt

This is the title


Hello world,
2021

This is a static site

I love programing

Command ran

ssg -i test.txt -s 'https://cdn.jsdelivr.net/npm/water.css@2/out/water.css' -l en-US

Output file:
dist/index.html

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <title>Home</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css" />
  </head>

  <body>
    <h1>Home menu</h1>
    <h2>Summary</h2>
    <ul>
      <li><a href="test.html">test</a></li>
    </ul>
  </body>
</html>

dist/test.html

<!DOCTYPE html>
<html lang="en-US">
  <head>
    <meta charset="UTF-8" />
    <title>This is the title</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css" />
  </head>

  <body>
    <h1>This is the title</h1>
    <p>Hello world,2021</p>
    <p>This is a static site</p>
    <p>I love programing</p>
  </body>
</html>

Example - Using configuration JSON file

Input file: test.txt

This is the title


Hello world,
2021

This is a static site

I love programing

Config file: config.json

{
  "lang": "en-CA",
  "output": "./newDist"
}

Command ran

ssg -c samples/config.json -i test.txt

Output file:
newDist/index.html

<!DOCTYPE html>
<html lang="en-CA">
  <head>
    <meta charset="UTF-8" />
    <title>Home</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css" />
  </head>

  <body>
    <h1>Home menu</h1>
    <h2>Summary</h2>
    <ul>
      <li><a href="test.html">test</a></li>
    </ul>
  </body>
</html>

newDist/test.html

<!DOCTYPE html>
<html lang="en-CA">
  <head>
    <meta charset="UTF-8" />
    <title>This is the title</title>
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css" />
  </head>

  <body>
    <h1>This is the title</h1>
    <p>Hello world,2021</p>
    <p>This is a static site</p>
    <p>I love programing</p>
  </body>
</html>

Author

👨‍💻 Kevan Yang

Show your support

Give a ⭐️ to this project.

Dependents (0)

Package Sidebar

Install

npm i text-ssg

Repository

github.com/Kevan-Y/text-ssg

Homepage

github.com/Kevan-Y/text-ssg#readme

Weekly Downloads

1

Version

1.0.3

License

MIT

Unpacked Size

883 kB

Total Files

67

Last publish

Collaborators

  • kevan-y
Try on RunKit
Report malware