Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.36 KB

README.md

File metadata and controls

35 lines (26 loc) · 1.36 KB

Discord

The Binding of Isaac: Afterbirth+ Community Documentation Project

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.

New features

  • 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!

Technology used

  • 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

Creating a local version

  1. Clone the repository.
  2. Install a current version of Python 3.x.
  3. pip install -r requirements.txt
  4. cd IsaacDocs
  5. Use mkdocs serve to create a locally hosted version of the page available at: http://127.0.0.1:8000/
  6. Alternatively, use mkdocs build to build a static version of the page.