Our project's documentation is very important and is essential when developing an application using our framework. Our documentation is made with Jekyll & Liquid and is hosted on GitHub. Your contribution to this documentation is always appreciated.
This repository does not accept issues, only Pull Requests. If you have any issue with the documentation, feel free to get into the "Twitch API" Discord's "#tmi" channel, invite link on the tmi.js repo README.
- You can hide a version in the
hidden_versionsfield of_config.yml - You can change the latest version in the
latest_versionfield of_config.yml - You must provide a date in the filename with Jekyll
- You must specify the version as a category in the header of each document
- Download and install Ruby
- Download and install Jekyll
- Git clone this repository
- Modify
_config.ymland change theurltohttp://127.0.0.1:4000 - Run
jekyll serve --watch