drew5494 / the-great-site-generator Goto Github PK

In https://github.com/drew5494/the-great-site-generator/blob/main/thegreatsitegenerator/main.cpp#L20 the version number is hard-coded. This isn't ideal, since it will change with every release. A better way is to include it in an external header file as a #define or the like, see https://stackoverflow.com/questions/27395120/correct-way-to-encode-embed-version-number-in-program-code for tips.

Make sure that the program exits with appropriate error codes in all cases. If there are no errors, exit with 0. Otherwise, exit with a 1.

What is Not Working?

The tool turns every text line into a paragraph element instead of turning text with spaces between them as paragraph elements.

How Should it Work?

     THIS IS A TEST THIS IS A TEST
     This is a test
     
     THIS IS A TEST THIS IS A TEST 

     Should be parsed to this:
     
     <p>THIS IS A TEST THIS IS A TEST This is a test</p>
     <p>THIS IS A TEST THIS IS A TEST</p>    

It's dangerous to work with filenames and paths as though they are strings, and make assumptions about how they will be constructed. Especially as you move between operating systems and filesystems, the standards change.

For example, in https://github.com/drew5494/the-great-site-generator/blob/main/thegreatsitegenerator/main.cpp#L59 you assume the path separator. A better approach is to use something like https://en.cppreference.com/w/cpp/filesystem/path to extract path components and/or put them together.

Why Do We Need This?

It would make working with large amount of files a lot easier.

What does this enhancement include?

• If the input is a folder, the tool should scan the entire folder looking for text files and output them in the dist folder.

The README is mostly aimed at developers who want to build the code. It should also include details for users you want to run the code. You should discuss how the program works (e.g., flags, args to pass, and their meaning), show examples, and give a sense of the kind of input/output to expect.

Hi Drew5494!

Feature

I am interested in your project and I would like to add support for Markdown (.md files) in it.

Example

If users inputs a text file, nothing will change. If a Markdown file is used as input, only the header one syntax feature will be converted into HTML.

If you would like this feature please assign me this issue and reply to let me know. Thanks!

What is Not Working?

Text files are only able to be converted to HTML files if they're in the .exe folder.

How Should it Work?

Text files should be able to be parsed in other places on the computer.

A missing feature is to extract and use the title of the document, as defined by a line of text with 2 empty lines after it at the start. This should be used to populate the title and an h1 element.

Working with C++ is a great way to target multiple operating systems and platforms. Doing so requires you to have a build system that works across various systems. Currently there is no build system, and you give a manual command to compile the code.

A better solution is to use something like CMake or the like. This can be integrated with Visual Studio and other IDEs later on.

The README does not contain information on the tools features or examples. If there was more information on what can be done with tool and some examples of how to use these features, it would make the tool easier to use.

Add support for multiple languages.

How Should it Work?

User should be able to specify language for html.