Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 3.2 KB

README.md

File metadata and controls

48 lines (36 loc) · 3.2 KB

ChiaLinks.com

ChiaLinks.com is a collection of curated links and resources for the Chia community.

Besides the collection of links, there are a number of resources original to ChiaLinks.com:

Build and deployment

The site is a static site built with Jekyll with the Just The Docs template. Flat icon set by baianat from www.flaticon.com used with attribution.

Local build

  1. Install Jekyll (incl. ruby) - Instructions
  2. Clone this repo
  3. Install required gems with bundle install
  4. Compile and serve site to localhost with bundle exec jekyll serve

Triggered deployment

It is currently hosted on a DigitalOcean's App Platform (basic free tier) with builds triggered on any code change on the main GitHub branch.

It can alternatively be deployed to GitHub pages.

Code structure

The general design of the site involves flat files of link entries associated with a set of one or more predefined tags. These tags determine which page and/or section a link shows up under.

Main tag categories (_labels)

Each page here contains a short page introduction and fetches & formats all links associated with that particular tag. Some pages such as wallets or exchanges contains custom formatting besides the default link listing.

featured and verified tags are handled uniquely to display them on the front page or add a green checkmark respectively.

Data Files (_data)

These YAML flat files contain the items and link entries that are parsed by the various pages and layouts.

  • links.yml entries for all links on the site
  • news.yml entries for news mentions of Chia
  • roadmap.yml roadmap-future.yml entries to populate the Chia Roadmap/Timeline
  • tags.yml specifies special handlings of tags such as which tags should use sections and which tags are considered sections themselves.

Link iteration and formatting (_includes)

The various includes code blocks are used throughout the individual pages to format arrays of data (usually links). See comments in each for how the logical flow works.