Since, it's a tiny little cmd line utility, all you do is execute a few commands for your desired output.
You should be able to get a binary for your specific system from the github releases of this project or compile it from source if you like doing things that way (can't judge, can I?)
docs with all the
markdown files in it. and all you have to do is run mudkip to generate what
you see if you are reading this documentation on the website
$ mudkip
$ mudkip --in='docs' --out='dist'
A few flags that'll help when working with these docs.
$ mudkip --poll # run the conversion every 3 seconds
Yeah, I said it's not customizable, but it's not like you don't lie. Anyway, the only set of customization offered is that of styles.
You can refer the static/default-styles.css from the
source code to see what the default
styles are, also you can add in your styles using the below flag
$ mudkip --stylesheet='./styles.css'
This will copy your stylesheet to the destination instead of writing the default style
Not every hosting platform allows you to have a custom domain and in various cases you'd like the documentation to use the the custom sub path.
In which case you can specify a custom base URL by using the --baseurl flag.
mudkip --baseurl='/mudkip/'
This will replace any markdown urls that start with / to /mudkip/ and your
hosting service can handle the rest