This 2-week's lab called for a 2-part submission.
1. Docusaurus - create, build, host!
If you've never heard of it - It's a real thing! I was shocked when I heard that was what it was called.
Docusaurus is basically an application to generate html pages, easily and quickly. I thought it would be relatively difficult to download - to my surprise I had no issues at all. The documentation was extremely simple and left little room for "user-errors".
After launching the application, I followed the tutorial in the browser and learned how to create a page, documents, and a blog. Once I completed this, I did have to jump through some hurdles trying to host. To be fair, it's never my lucky day when I have to host something on GitHub Pages, but the good news is I love the docusaurus logo!
2. The Issue
After realizing there was an emphasis in the issue for this lab, I decided to be a little more thorough. Reading the list of the different features to implement, two features pooped out - themes and full markdown support. I knew there were a lot of gaps in my markdown parser, and I felt uncomfortable saying it supports markdown... but only about 40%.
When I was looking at how to implement this, I spent two full days researching a library. So first I actually learned how to search npm packages, which I never really knew how. I quickly realized there's a webpage with all node package modules, and used that site to search more deeply. I chose a package that had everything I needed! I installed it and then went back to the page to save it, and noticed that it stated:
Support will end in 06/2021 to support other apps
This is where I realized "Oh no!". That is NOT what I want. I got back to the research and found markdown-it! This was perfect because it would parse line by line. The implementation was very easy, the only hurdle I had to deal with was that my application was using modules. I tested the implementation with a few markdown files, and all was working perfectly!
I feel that I've become more open to exploring other libraries and using them in my implementations. Having spent time researching put me at ease that I was using something dependable. This was not the case when I created the CLI for the SSG. I realized afterwards that a majority of my classmates had opted to use a package to parse the cli arguments. This made me realize how inefficient my approach was.
Top comments (0)