Fast and nice SSG written with typescript and node.js
Run: npm install izyum -g
izyum -v | --version
- shows currenly installed app versionizyum -h | --help
- shows help message about ways to use the appizyum -i | --input [path to .txt file]
- transforms provided .txt file to htmlizyum -i | --input [path to dir]
- transforms all .txt files in that directory or in it's child directories to htmlizyum -c | --config [path to .json file]
- performs commands specified injson
format
The project has test directory which has some .txt files that you could use for testing purposes
izyum -i tests
or
izyum --input tests/The Adventure of the Speckled Band.txt
- 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>
- 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.
- 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 />
- 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 callizyum --input tests
.