limi / MkDocs_MiSTer

MiSTer FPGA Documentation site built using Material for MkDocs.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MkDocs_MiSTer

https://MiSTer-devel.github.io/MkDocs_MiSTer/

MiSTer FPGA Documentation built in Material for MkDocs.

Useful resources

Software used

Instructions for deploying a local environment

Prerequisites:

  • Python 3
  • Pip

Make sure you update python 3 and update pip. Then, cd into the root folder of this repo and install the requirements:

pip install -r requirements.txt

Deploy to local server from that root folder:

mkdocs serve

And it should give you a weburl in the terminal to go to --> http://127.0.0.1:8000

Credits

Huge thanks to @tofukazoo (Jorge González) for helping me with the initial GitHub automation, lots of conceptual brainstorming, important early-stage debating, and finally the motivation and encouragement to get this project going!

Thanks to @Kitrinx, @sentientsix, @alanswx, @MiSTerAddons, @Tonurics, @theypsilon, and many more for so much help and advice with the content written and with the initial layout!

Thanks to @hewhoisred for supplying art and giving expert UI design and aesthetics advice!

Thanks to Conrad Fenech for the logo design!

Thanks to @sorgelig (Alexey Melnikov) for all of his amazing hard work on the MiSTer FPGA project that we all are so happy to enjoy!

About

MiSTer FPGA Documentation site built using Material for MkDocs.

License:Other


Languages

Language:HTML 100.0%