hunterfancompany.github.io

hunterfancompany.github.io

A central community-backed place to request and give help when troubleshooting your Hunter SIMPLEconnect Fans.

Project Structure

Project aims to serve static content for “articles” section in the app.

├──    articles
│    ├──    errors
│    │   ├── id
│    │   │   ├── en.json    # ISO 639-1
│    │   │   ├── en.md      # generated by 
scripts/generate-articles-md.sh
│    ├── how-to
│    ├──    all.json        # generated by /scripts/generate-articles.sh
│    ├──    all.md          # generated by 
/scripts/generate-articles-md.sh
├── scripts
│   ├── **/*.sh
├── uploads
│   ├── **/*.png

Article.json Structure

id description type
id Unique ID int, unique
title Article title string
description Article body supporting MD string
image (Optional) Body image path string (null)
related Related articles list array
fallback (Optional) Fallback article int (null)
[
  {
    "id": 1,
    "title": "Article Title",
    "description": "Description with *MD* support.",
    "image": null,
    "related": [
      2,
      3
    ],
    "fallback": 2
  },
  {
    "id": 2,
    "title": "Fallback Article for the first article",
    "description": "This is a **fallback** article which should be called on 
a user 'thumbdown' action if the first article wasn't relevant.",
    "image": "/uploads/2.png",
    "related": [
      1
    ],
    "fallback": null
  }
]

Other Hunter Fan Resources