Skip to content
/ izyum Public

Fast and nice SSG written with typescript and node.js

License

Notifications You must be signed in to change notification settings

Myrfion/izyum

Repository files navigation

Izyum 🍇

Fast and nice SSG written with typescript and node.js

Installation

Run: npm install izyum -g

Commands

  • izyum -v | --version - shows currenly installed app version
  • izyum -h | --help - shows help message about ways to use the app
  • izyum -i | --input [path to .txt file] - transforms provided .txt file to html
  • izyum -i | --input [path to dir] - transforms all .txt files in that directory or in it's child directories to html
  • izyum -c | --config [path to .json file] - performs commands specified in json format

Examles

Test files

The project has test directory which has some .txt files that you could use for testing purposes

Usage examples

izyum -i tests

or

izyum --input tests/The Adventure of the Speckled Band.txt

Implemented optional features ✅

  1. try to parse a title from your input files. If there is a title, it will be the first line followed by two blank lines. In your generated HTML, use this to populate the <title>...</title> and add an <h1>...</h1> to the top of the <body>
  2. allow the input to be a deep tree of files and folders. That is, if the user specifies a folder for --input, check to see if any of the items contained within are folders and recursively parse those as well.
  3. Allow the input to be a markdown file. If the user specifies a file with .md extension for --input, the tool will look for instances of lines beginning with # , and add those lines inside individual <h1>...</h1> tags. Similarly, if the tool detects lines beginning with ## , then those lines will be added within individual <h2>...</h2> tags. Furthermore, text marked within a pair of ** will be transformed into bolded text, text marked with ` will be transformed into html code text. For example: **Tom is a cat** will be converted into <strong>Tom is a cat</strong>. Additionally, the line marked with 3 or more dash symbols (---) is converted to the <hr />
  4. Allow for reading configuration file, performing speicified commands and arguments as keys and values, e.g calling izyum --config config.json with JSON entry as "input": "tests" will call izyum --input tests.