Git Product home page Git Product logo

docs's Introduction

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

docs's People

Contributors

schmoopiie avatar alcadesign avatar jonliney avatar dqkev 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.