neilan99 / nan1-ssg Goto Github PK

I believe it is best practice to add the node_modules to a .gitignore file (so that it doesn't get committed in git).

I think the main 2 reasons for this are:

• possible conflicts in different operating systems (windows, mac, linux)
• potentially committing dev dependencies along with project dependencies

The plan is to swap out the current implementation of markdown support to a fully supported version from an open source library.

In the image above I think the blueish background conflicts with the blue/ purple links. I think it might be nice to change the color scheme to make it a little easier to read.

See this line:

Instead use version from package.json (ex const { version } = require(‘./package.json’);)

Add a lang attribute to the root HTML element, which indicates the language for the HTML to use.

All the .js files should be in a separate src folder. Testing files should also be in their own folder. File names are preferred as lower case (generate-html.js vs generateHTML.js).

Use the markdown support found in this library: showdown

I believe for this project, we are required to be able to run the command without explicitly using "node" before the command.

ie:
main -i hello.txt
instead of
node main -i hello.txt

In generateHTML.js Lines 156 and 157 are essentially the same variable, I think you should remove one for brevity.

The same goes for Line 163 and Line 164.

I'd like to work on this to add support for converting .md to .html files, and also add the ability to parse bolded text.

The current colour contrast from foreground to background makes the text hard to read. Also, the text should be left aligned instead of centre aligned.

Whenever --- appears in a markdown file, it should be translated to an <hr> tag in HTML.

Instead of having users specify all of the SSG options as command line arguments, they should be able to pass in a JSON formatted configuration file containing all options.

Ex:

nan1-ssg --config ./ssg-config.json

Example config file:

{
  "input": "./site",
  "output": "./build",
  "stylesheet": "https://cdn.jsdelivr.net/npm/water.css@2/out/water.css",
  "lang": "fr"
}

Hello, I would like to commit a new test here

currently the program doesn't allow you to specify a folder containing text files other than the one where the program resides