All Projects → tmijs → docs

tmijs / docs

Licence: other
Documentation for tmi.js

Programming Languages

CSS
56736 projects
HTML
75241 projects
ruby
36898 projects - #4 most used programming language

Projects that are alternatives of or similar to docs

tmi
PHP Twitch Messaging Interface
Stars: ✭ 19 (-77.38%)
Mutual labels:  tmi
twitch-spambot
An automated twitch spam user
Stars: ✭ 27 (-67.86%)
Mutual labels:  tmijs
twurple
Interact with Twitch's API, chat and subscribe to events via PubSub and EventSub.
Stars: ✭ 479 (+470.24%)
Mutual labels:  tmi
twitch-chat-monitor
Twitch Chat Monitor that allows the chat to be shown comfortably on a big monitor. Useful for room-scale streaming where the chat needs to be readable from a distance.
Stars: ✭ 28 (-66.67%)
Mutual labels:  tmi
twitch api2
Rust library for talking with the Twitch API aka. "Helix", TMI and more! Use Twitch endpoints fearlessly!
Stars: ✭ 91 (+8.33%)
Mutual labels:  tmi
twitch-chat-visualizer
A Node.js Project. Would you like to see your chat stream with a custom design? This is for you!
Stars: ✭ 14 (-83.33%)
Mutual labels:  tmijs

tmi.js - docs

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.

Tips & Tricks

  • You can hide a version in the hidden_versions field of _config.yml
  • You can change the latest version in the latest_version field 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

Hosting the documentation locally

  • Download and install Ruby
  • Download and install Jekyll
  • Git clone this repository
  • Modify _config.yml and change the url to http://127.0.0.1:4000
  • Run jekyll serve --watch
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].