Our great sponsors
my-ssg | mh-ssg | |
---|---|---|
10 | 13 | |
0 | 1 | |
- | - | |
0.0 | 0.0 | |
over 2 years ago | over 2 years ago | |
JavaScript | JavaScript | |
MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
my-ssg
Posts with mentions or reviews of my-ssg.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2021-10-29.
-
OSD600 - Publishing my-ssg To NPM
After a long time updating my-sgg with new features, this time is an appropriate time to provide a release that allows users to install and use the tool easier.
-
OSD600 - Adding new feature from Docusaurus
View my commit at 11c9ed8
-
OSD600 - Refactoring My SSG
As my-ssg was updated with a lot of new features over the past few weeks and these features were written by different contributors, my-ssg's source code will unavoidably contain duplicated logic, inconsistent naming conventions, etc...
-
OSD600 - Using Git Remote And Git Merge For Collaboration
3. Reviewing and testing Dustin's work on my ssg using git remote
-
Adding new feature for a static site generator written in Javascript
My issue link My pull request Her repo
-
OSD600 - Working In Multiple Branches
In this lab, I am going to make some changes to my repo, they are listed below:
-
Getting started with pull requests
First, I decided to check the repo and noting down everything I could. Carefully examined how Vivian wrote the project allowed me to avoid unnecessary changes and ensure that the new code I wrote would not break the existing ones. Once satisfied, I decided to file an issue describing in detail what I wanted to do. The plan was:
-
OSD600 - Review SSG Code
At first, Minh Hang found out the -o or --output option specified in the help section, however, it has not been applied yet. I solved this problem by commenting this option out cause I intend to implement that feature in the next version of the tool.
-
1st collaboration for open source
During the testing and reviewing for her code, I have encountered both minor and major issues. Minor issues are related to documentation: there was a mismatch between actual functionalities and the options in Help section and Readme file was missing installation guide. Both were quickly resolved after the issues were filed.
- OSD600 - My First Command Line Tool
mh-ssg
Posts with mentions or reviews of mh-ssg.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2021-11-18.
-
Publishing my first package
This week, I've published my 1st package on npm - mh-ssg - a static site generator CLI.
-
Adding Continuous Integration to a Project
I also worked on another project, mh-ssg, and added tests to this project as well. I created unit tests for a function called processFolder(). This function accepts an input folder path, output folder path and stylesheet URL. I created two unit tests, one which tests when a valid input folder containing files is passed to the function and one which tests when a non-existent folder is passed to the function. The function logs a message to the console depending on how many files are saved in the output folder, so the tests I wrote tested for these console logs.
-
Add testing to SSG
For this lab, I picked Jest as the testing tool for mh-ssg. This is a popular Javascript testing framework thanks to its simplicity and ease of usage.
-
Adding Static Analysis Tools to SSG
To maintain the quality of source code, I added a formatter and a linter for my project.
-
Static Site Generator - Support static files
Throughout the previous week, I was exploring Docusaurus and found that they have a feature to support static files. I find this feature very useful for any static site generator since images, favicons, stylesheets, etc. are very common parts of a webpage. Therefore, I decided to add this feature in my tool.
-
Code Refactoring and Rebase
As new features are added to the tool, I realized that the logic is not clear anymore and some parts were duplicated, making it inefficient and hard to maintain. This time, I decided to focus on removing those duplications by moving the statements to the appropriate place and extracting function for reusability. All the refactoring was done through a single commit with the help of git rebase.
-
Working with git remote - approving new feature
Luke also implemented the same feature for my project. His code in general was good but I suggested some changes including separating modules and combining functions to remove code duplicates.
-
A different way of reviewing pull requests
After looking through my classmates' projects, I decided to work on Minh Hang's static site generator and filed an issue to her repo.
-
Merges and conflicts
In the last update, my friend - Dustin - helped to add Markdown as a valid input for my tool. Markdown syntaxes are different from HTML syntaxes and he has worked on converting some of them. This time I decided to add two more:
-
Collaboration and pull requests
I've been sending a lot of pull requests but this was actually my first time receiving one 😄 and Dustin was my first contributor. He also proposed to add Markdown support for my tool and to parse all the headings, bold, italics and link from markdown into the corresponding HTML tags. I scanned through the pull request and found some minor issues, including missing new feature in documentation and missing the handling of the output file name. We also had different opinions about the implementation of .txt file and .md file. However after discussion, we came to agreement and I approved his changes.
What are some alternatives?
When comparing my-ssg and mh-ssg you can also consider the following projects:
Docusaurus - Easy to maintain open source documentation websites.
yargs - yargs the modern, pirate-themed successor to optimist.
markdown-it - Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed
mini-ssg - MINI - A minimalist static site generator written in JS.