You can view the website for this repository here: https://wofsauge.github.io/IsaacDocs/
This project aims to make the Binding of Isaac modding documentation better by providing additional information, features, and a more modern design.
- Fully responsive and modern design
- Vastly improved search function
- Last visited pages - history
- Dark mode
- Quick Edit - Button
- Smart-Copy Feature to quickly copy
- Automatic deployment & updates (using Github actions)
- and a lot more!
- MkDocs as the static site generator
- MKDocs Material Theme
- mark.js for better search highlighting
- Python 3.x + Beautiful Soup for conversion tools
- CSS3 & JQuery for custom scripts
- Clone the repository.
- Install a current version of Python 3.x.
pip install -r requirements.txt
cd IsaacDocs
- Use
mkdocs serve
to create a locally hosted version of the page available at:http://127.0.0.1:8000/
- Alternatively, use
mkdocs build
to build a static version of the page.