Yep, to make good looking documentation using mkdocs which is a site generator is the most common option.
I have made an Imgur album tutorial to help you out, to start publishing a mkdocs website on a new public GitHub repository, using vscode though any other code editor will work like in pycharm IDE.
You can later follow a similar method to publish the repository on the same public GitHub repository as your open-source module but yeah it’s recommended to practice a bit and make a few mistakes as you can just delete the repository later.
This tutorial assumes you are:
Logged into git and GitHub in the terminal
Have VsCode installed, The reason why VsCode is used is that if you already use GitHub on Roblox you are most likely using Rojo through the VsCode extensions as it’s very easy to install and setup Rojo this way.
Have python installed
Have installed mkdocs already, using python through “pip install mkdocs” in the terminal
To style and format your docs and to actually use the material theme you can follow the Material for MkDocs documentation linked by @loleris as well as the MkDocs documentation and how to use markdown to write the websites.