Welcome!
Though it's nothing fancy, I made this site using MkDocs and Material for MkDocs to show my proficiency in Markdown and ability to use static site generators to build content. The following sections go into more detail about how this site came to be.
Why MkDocs?
Initially, there wasn't really any particular reason for choosing MkDocs over Docusaurus, Sphinx, Jekyll, or any of the myriad other static site generators out there. As I began working my way through the MkDocs documentation, however, I quickly became a fan for the following reasons:
- Easy to install and configure. Despite my limited experience with static site generators, MkDocs made it incredibly easy to get up and running.
- Customizable look and feel. While it does have some limitations, MkDocs offers enough flexibility to give my site its own flavor to match my needs.
- Trusted by industry leaders. If it's good enough for companies like Atlassian and Mozilla, it's good enough for me.
- Markdown. When it comes to writing documentation, Markdown feels infinitely cleaner than dealing with HTML (though I'm comfortable with both!). Markdown's portability is another plus.
How Did I Build This?
The MkDocs site has a wonderful Getting Started with MkDocs topic that had me building a brand new site in minutes. Of course, after that, I did have to spend some time digging through documentation to configure the look and feel, install plugins, and create the actual written content.
For hosting, I opted to use GitHub Pages, which serves as a great free option for small projects like this.
What's Next?
In the coming days/weeks, I anticipate continuing to grow this site, hopefully generating something that feels more like a true documentation repository.