potato-generator VS txt2html

This week, I worked on my Static-Site Generator - Potato Generator to add package registry. My SSG is in C++ language. I chose Conan, GitLab, to publish my package officially.

Finally, I moved onto working on Kien's potato SSG. His setup with catch2 is similar to mine, we both have it set up to provide us a main which we compile separately when we want to test it, rather than having it integrated into the program all the time. This made it easy to get started on his, I read his contributing.md which specified one should create a new source file to write their desired test cases, which I did. After messing around with file paths for a bit and figuring out how to get my test to pass, I pushed a commit and created a pull request with a test for his HTMLFile.getTitle() function. Unfortunately I realized with the workflow he had set up this wouldn't trigger his CI so I opted to insert my test case in test.cpp instead to see if it passed his workflow, which thankfully it did.

This week, I set up GitHub Action for my Static Site Generator (SSG). There are several options with C++ language and I picked C/C++ with Make to implement.

You can take a closer look at all the testing files that I created so far and folder structure in the commit.

This week, I work on my Static Site Generator (SSG) - Potato Generator. I plan to implement a source code formatter for my project, which is clang-format and a linter, which is clang-tidy.

This week, I'm working on my Static Site Generator (SSG) - Potato Generator to add a new feature for it.

This week, I work on my Static Site Generator (SSG) in C++ - Potato Generator. After weeks that people worked on and fixed my code. Finally, I have time to revise everything, make my first commit with Git Rebase, Squash and Amend

Back to potato generator, I kept chipping away at it and had it almost ready to go this afternoon when I found I had glossed over the logic for supporting multiple languages in HTML. I didn't realize why he was iterating over the CLI arguments when in my SSG they were always in the same place relative to one another, so I did away with all those loops yesterday only to have to restore them today. After several tests I pushed the changes which (he then merged as well)[https://github.com/kiennguyenchi/potato-generator/pull/12].

This is actually my first time working with Pull Request, and once again I choose Kien Nguyen as my partner for this lab. Based on the previous lab, I have noticed how he writes his program, as well as being familiar with the structure of Kien's program.I also check his repo to see if he would make any changes in his code. And this time, I would love to add Markdown Support Feature in his program. More specifically, I will make some adjustments to process .md file and implement Markdown syntax for Heading 1. This time, I have to be extra careful when modifying his code, I am trying to make less changes as much as possible ^!^. Let see how I make changes to his code in order to support Markdown file mentioned above.

Hello all, this week I have to add a Testing Framework to my program-SSG. By doing this, I will be able to test different pieces of my code. Moreover, I also have a basic concept about how to test a program. My program is still small compare to others project, which is super convenient when we know how to test it, and what to test. Let's get started!

I pick Prettier for my project. It will help me fix any format issue and make my code look "prettier" as its name. In order to install it, I type:

As I catch up the concept of Docusaurus as well as knowing what it is, I choose a feature from it and add it into my SSG. I file an issue inside my repo, which is adding full markdown support for my SSG. The reason why I choose this is because I partially implement the heading to

The first thing I need to do is make sure I update everything from my Github into my local machine. Then I create another branch named refactoring, and I will do my changes in this branch, which will not affect any things in my original code.

After he is done his task with my code and send me a pull request, I reviewed it and pulled his code into my machine, I was kind of surprised because a new logic was applied into my code and there were so much things for me to learn. Reviewing a Pull Request by fetching to my local machine is way effective than checking it on Github. Once I satisfy with the new feature, I merge his work to my main branch.

This week I have to add another two features in my program, which is inline code block and horizontal rule. To be honest, I am able to know Git can do so many things out there, working with multiple branches in parallel is an example of this week.

Additionally, he uses Visual Studio to do his code, so when I clone his code to my machine and open it in Visual Code, I have to install C/C++ extension, but he does not mention it in his instruction. Other than that, his code is short and explained, which is easy for me to catch what is happening in this program. Kien also comes up with some issues I have in my program. Initially, I put all the text file into a single paragraph tag, I fix this one by correcting regex in my function, I mix up [] and () in my program.

At first, I have some difficulties to run his code. I need to install some required packages to run (which not specify in the README). After all, everything goes fine to test his code. He has few issues on his code. He put all the text file into a single paragraph tag. He has not specify detailed packages needed to install to run the program on README. His code is organized but he needs few comments to explain how it works. The optional features about external stylesheet and specifying output folder work great. I would list some errors or recommendations to improve his code in the Issue Page on his repository: https://github.com/tcvan0707/txt2html/issues/1

View soure code on GitHub