https://github.com/tmijs/docs

Documentation for tmi.js
https://github.com/tmijs/docs

documentation jekyll tmi tmijs

Last synced: 6 days ago
JSON representation

Documentation for tmi.js

• Host: GitHub
• URL: https://github.com/tmijs/docs
• Owner: tmijs
• Created: 2016-05-09T21:52:29.000Z (over 8 years ago)
• Default Branch: gh-pages
• Last Pushed: 2023-04-12T23:00:13.000Z (over 1 year ago)
• Last Synced: 2023-10-20T23:30:33.094Z (about 1 year ago)
• Topics: documentation, jekyll, tmi, tmijs
• Language: CSS
• Homepage: https://tmijs.com
• Size: 126 KB
• Stars: 91
• Watchers: 10
• Forks: 49
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://github.com/tmijs/tmi.js).

### 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```