kaytotes / tswow-wiki

Public wiki of TSWoW

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TSWoW Wiki

This is code backing the Wiki for TSWoW, hosted through GitHub pages. You can view the wiki here.

Development

This wiki uses the minimal-mistakes jekyll theme, you can see their documentation for how the project is structured. We use some custom css in _sass, a redirect at _layouts/home.html and some custom javascript to render edit/author links, but otherwise this is a fairly standard installation.

Some notes for testing and developing this wiki locally:

  • Check out GitHubs guide for previewing Jekyll sites

  • Many paths are currently hardcoded to the tswow wiki url specifically, especially for editing and author data.

  • The homepage redirect does not work when hosted locally, but you can still access the homepage by clicking the Home button.

  • We use the GitHub API to query author data from the browser, and since this is rate-limited to 60 requests per hour and IP we cache that information in localStorage for 24 hours per page.

  • Changes to _config.yml requires you to restart the server process, it does not reload like the other files.

About

Public wiki of TSWoW

License:GNU General Public License v3.0


Languages

Language:SCSS 96.5%Language:JavaScript 2.7%Language:HTML 0.4%Language:Ruby 0.4%