Git Product home page Git Product logo

isaacdocs's Introduction

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.

isaacdocs's People

Contributors

wofsauge avatar zamiell avatar kittenchilly avatar im-tem avatar xalum avatar yannickfricke avatar piber20 avatar ocixcrom avatar agentcucco avatar saturnaliam avatar fedew04 avatar jsgnextortex avatar valentinlampriere avatar dcavederps avatar ghgibonus avatar anumania avatar thicco-catto avatar veeyu22 avatar epfly6 avatar goldenstein64 avatar laceous avatar pedroff1 avatar arcey-bot avatar unit-03 avatar sweetmnm avatar rchardon avatar meowlala avatar lepadawan avatar gemboat avatar dfreezerr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.