ssgnode v0.1.1
SSGNode
Watch it work
Static
Site
Generator
This tool allows you to generate web pages from text files.\
You can specify a file/folder to generate into valid html pages. They will appear in ./dist*.
You can also change the styles.css to fit your preferences, it will get copied over to ./dist and will be applied to all webpages there.\
It also recognizes the first paragraph as a title.
How to use
You should have a .txt or .md file or a folder of such files, or instead "Sherlock Holmes Selected Stories" folder with txt contents present for testing this tool.\
\
Make sure to have node.js installed on your system.\
Then, in the repository run
npm installIf you ever get an error of a missing node module, you can always look at its name (it will have a message Error: Cannot find module module) and run
npm install **module**Run in your console
node index.jsArguments
You can specify additional options through arguments like so:
node index.js -argument --argument inputTo get quick instructions on the arguments do:
-h or --help
To check the version of the app:
-v or --version
To change language of the page (it's set as en by default. It will be put in as an attribute to <html>, such as <html lang="en"> ):
-l or --lang
To change the default directory from where the files would be read or the specific file:
-i or --input
To specify a config file to read from:
-c or --config
Example of usage:
node index.js -i catsWill convert everything from folder cats to html pages.
Please note you shouldn't add ./ in the beginning, since the app will do it for you
If you wish so, you also can:
-hi or --hello
MD file support:
This static site generator now reads the md file and converts them to html files with limited styling.
Features supported:
#to<h1>and other headers_to<i>__to<b>---to<hr>
Example of usage:
SSG Node
will be converted into the html format for heading tag.
<h1> SSG Node </h1>
Config file support:
You can now specify a config file to automatically run options specified there.
It has to be in a JSON format and can take in 3 options:
"input":
"output":
"lang":