Skip to content

Commit cd96526

Browse files
committed
created a readme file.
1 parent 81135c0 commit cd96526

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# tmi.js - docs
2+
3+
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.
4+
5+
This repository does not accept issues, only Pull Requests. If you have any issue with the documentation, feel free to contact [email protected] or any member of our organization.
6+
7+
### Tips & Tricks
8+
9+
- You can hide a version in the ``hidden_versions`` field of ``_config.yml``
10+
- You can change the latest version in the ``latest_version`` field of ``_config.yml``
11+
- You must provide a date in the filename with Jekyll
12+
- You must specify the version as a category in the header of each document
13+
14+
### Hosting the documentation locally
15+
16+
- Download and install Ruby
17+
- Download and install Jekyll
18+
- Git clone this repository
19+
- Modify ``_config.yml`` and change the ``url`` to ``http://127.0.0.1:4000``
20+
- Run ```jekyll serve --watch```

0 commit comments

Comments
 (0)